Record Class RPCInvocationResult.Success

java.lang.Object

java.lang.Record

eu.cloudnetservice.driver.network.rpc.handler.RPCInvocationResult.Success

Record Components:

invocationResult - the value returned from the method invocation.

invocationHandler - the handler that handled the invocation request.

invokedMethod - the method that was invoked during handling of the RPC request.

All Implemented Interfaces:

RPCInvocationResult

Enclosing interface:

RPCInvocationResult

public static record RPCInvocationResult.Success(@Nullable Object invocationResult, @NonNull RPCHandler invocationHandler, @NonNull RPCMethodMetadata invokedMethod)
extends Record
implements RPCInvocationResult

Represents a successful method invocation via RPC. This wraps the value returned by the called method.

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from interface RPCInvocationResult

RPCInvocationResult.BadRequest, RPCInvocationResult.Failure, RPCInvocationResult.ServerError, RPCInvocationResult.Success

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 RPCMethodMetadata	invokedMethod	The field for the invokedMethod record component.

Fields inherited from interface RPCInvocationResult

STATUS_BAD_REQUEST, STATUS_ERROR, STATUS_OK, STATUS_SERVER_ERROR

Constructor Summary

Constructors

Constructor	Description
Success(@Nullable Object invocationResult, @NonNull RPCHandler invocationHandler, @NonNull RPCMethodMetadata invokedMethod)	Creates an instance of a Success record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
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.
@NonNull RPCMethodMetadata	invokedMethod()	Returns the value of the invokedMethod record component.
final String	toString()	Returns a string representation of this record class.
boolean	wasSuccessful()	Get if the method invocation was successful or not.

Methods inherited from class Object

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

Field Details

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.

invokedMethod

@NonNull
private final @NonNull RPCMethodMetadata invokedMethod

The field for the invokedMethod record component.

Constructor Details

Success

public Success(@Nullable
 @Nullable Object invocationResult,
 @NonNull
 @NonNull RPCHandler invocationHandler,
 @NonNull
 @NonNull RPCMethodMetadata invokedMethod)

Creates an instance of a Success record class.

Parameters:

invocationResult - the value for the invocationResult record component

invocationHandler - the value for the invocationHandler record component

invokedMethod - the value for the invokedMethod record component

Method Details

wasSuccessful

public boolean wasSuccessful()

Get if the method invocation was successful or not.

Specified by:

wasSuccessful in interface RPCInvocationResult

Returns:

true if the method invocation was successful, false otherwise.

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

invocationResult

@Nullable
public @Nullable Object invocationResult()

Returns the value of the invocationResult record component.

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 RPCInvocationResult

Returns:

the value of the invocationHandler record component

invokedMethod

@NonNull
public @NonNull RPCMethodMetadata invokedMethod()

Returns the value of the invokedMethod record component.

Returns:

the value of the invokedMethod record component