Package dev.shamoo.runtime.core

Record Class OptionalProxyTransport.Response

java.lang.Object

java.lang.Record

dev.shamoo.runtime.core.OptionalProxyTransport.Response

Enclosing class:

OptionalProxyTransport

public static record OptionalProxyTransport.Response(boolean available, byte[] payload, String error)
extends Record

Explicit distinction between an absent carrier/proxy, a canonical response frame, and a local transport error.

Constructor Summary

Constructors

Constructor	Description
Response(boolean available, byte[] payload, String error)	Creates an instance of a Response record class.

Method Summary

Modifier and Type	Method	Description
boolean	available()	Returns the value of the available record component.
static OptionalProxyTransport.Response	available(byte[] payload)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	error()	Returns the value of the error record component.
static OptionalProxyTransport.Response	error(String error)
final int	hashCode()	Returns a hash code value for this object.
byte[]	payload()	Returns the value of the payload record component.
final String	toString()	Returns a string representation of this record class.
static OptionalProxyTransport.Response	unavailable()

Methods inherited from class java.lang.Object

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

Constructor Details

Response

public Response(boolean available,
 byte[] payload,
 String error)

Creates an instance of a Response record class.

Parameters:

available - the value for the available record component

payload - the value for the payload record component

error - the value for the error record component

Method Details

payload

public byte[] payload()

Returns the value of the payload record component.

Returns:

the value of the payload record component

available

public static OptionalProxyTransport.Response available(byte[] payload)

unavailable

public static OptionalProxyTransport.Response unavailable()

error

public static OptionalProxyTransport.Response error(String error)

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.

available

public boolean available()

Returns the value of the available record component.

Returns:

the value of the available record component

error

public String error()

Returns the value of the error record component.

Returns:

the value of the error record component