Package eu.cloudnetservice.driver.network.rpc.defaults.handler

Record Class DefaultHandlingResult

java.lang.Object

java.lang.Record

eu.cloudnetservice.driver.network.rpc.defaults.handler.DefaultHandlingResult

Record Components:

wasSuccessful - if the method invocation was successful or ended by an exception.

invocationResult - the result of the method invocation.

invocationHandler - the handler which is responsible for the class the method wss invoked in.

targetMethodInformation - the information of the method which was invoked.

All Implemented Interfaces:

RPCHandler.HandlingResult

public record DefaultHandlingResult(boolean wasSuccessful, @Nullable Object invocationResult, @NonNull RPCHandler invocationHandler, @NonNull MethodInformation targetMethodInformation)
extends Record
implements RPCHandler.HandlingResult

Represents the result of a method invocation.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private final @NonNull RPCHandler	invocationHandler	The field for the invocationHandler record component.
private final @Nullable Object	invocationResult	The field for the invocationResult record component.
private final @NonNull MethodInformation	targetMethodInformation	The field for the targetMethodInformation record component.
private final boolean	wasSuccessful	The field for the wasSuccessful record component.

Constructor Summary

Constructors

Constructor	Description
DefaultHandlingResult(boolean wasSuccessful, @Nullable Object invocationResult, @NonNull RPCHandler invocationHandler, @NonNull MethodInformation targetMethodInformation)	Creates an instance of a DefaultHandlingResult record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static RPCHandler.HandlingResult	failure(@NonNull MethodInformation information, @NonNull RPCHandler invocationHandler, @NonNull Throwable result)	Constructs a new failed invocation result, indicating that an exception was thrown as the result of the method call.
final int	hashCode()	Returns a hash code value for this object.
@NonNull RPCHandler	invocationHandler()	Returns the value of the invocationHandler record component.
@Nullable Object	invocationResult()	Returns the value of the invocationResult record component.
static RPCHandler.HandlingResult	success(@NonNull MethodInformation methodInformation, @NonNull RPCHandler invocationHandler, @Nullable Object result)	Constructs a new successful invocation result with the information provided.
@NonNull MethodInformation	targetMethodInformation()	Returns the value of the targetMethodInformation record component.
final String	toString()	Returns a string representation of this record class.
boolean	wasSuccessful()	Returns the value of the wasSuccessful record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

wasSuccessful

private final boolean wasSuccessful

The field for the wasSuccessful record component.

invocationResult

@Nullable
private final @Nullable Object invocationResult

The field for the invocationResult record component.

invocationHandler

@NonNull
private final @NonNull RPCHandler invocationHandler

The field for the invocationHandler record component.

targetMethodInformation

@NonNull
private final @NonNull MethodInformation targetMethodInformation

The field for the targetMethodInformation record component.

Constructor Details

DefaultHandlingResult

public DefaultHandlingResult(boolean wasSuccessful,
 @Nullable
 @Nullable Object invocationResult,
 @NonNull
 @NonNull RPCHandler invocationHandler,
 @NonNull
 @NonNull MethodInformation targetMethodInformation)

Creates an instance of a DefaultHandlingResult record class.

Parameters:

wasSuccessful - the value for the wasSuccessful record component

invocationResult - the value for the invocationResult record component

invocationHandler - the value for the invocationHandler record component

targetMethodInformation - the value for the targetMethodInformation record component

Method Details

success

@NonNull
public static RPCHandler.HandlingResult success(@NonNull
 @NonNull MethodInformation methodInformation,
 @NonNull
 @NonNull RPCHandler invocationHandler,
 @Nullable
 @Nullable Object result)

Constructs a new successful invocation result with the information provided.

Parameters:

methodInformation - the information of the method which was invoked.

invocationHandler - the handler which is responsible for the class the method wss invoked in.

result - the result of the method invocation.

Returns:

the constructed method invocation result.

Throws:

NullPointerException - if either the given method information or handler is null.

failure

@NonNull
public static RPCHandler.HandlingResult failure(@NonNull
 @NonNull MethodInformation information,
 @NonNull
 @NonNull RPCHandler invocationHandler,
 @NonNull
 @NonNull Throwable result)

Constructs a new failed invocation result, indicating that an exception was thrown as the result of the method call.

Parameters:

information - the information of the method which was invoked.

invocationHandler - the handler which is responsible for the class the method wss invoked in.

result - the exception which was thrown during the method invocation.

Returns:

the constructed method invocation result.

Throws:

NullPointerException - if either the given method information, handler or exception is null.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

wasSuccessful

public boolean wasSuccessful()

Returns the value of the wasSuccessful record component.

Specified by:

wasSuccessful in interface RPCHandler.HandlingResult

Returns:

the value of the wasSuccessful record component

invocationResult

@Nullable
public @Nullable Object invocationResult()

Returns the value of the invocationResult record component.

Specified by:

invocationResult in interface RPCHandler.HandlingResult

Returns:

the value of the invocationResult record component

invocationHandler

@NonNull
public @NonNull RPCHandler invocationHandler()

Returns the value of the invocationHandler record component.

Specified by:

invocationHandler in interface RPCHandler.HandlingResult

Returns:

the value of the invocationHandler record component

targetMethodInformation

@NonNull
public @NonNull MethodInformation targetMethodInformation()

Returns the value of the targetMethodInformation record component.

Specified by:

targetMethodInformation in interface RPCHandler.HandlingResult

Returns:

the value of the targetMethodInformation record component