Record Class WebSocketFrame

java.lang.Object

java.lang.Record

cool.scx.websocket.WebSocketFrame

public record WebSocketFrame(WebSocketOpCode opCode, byte[] payloadData, boolean fin)
extends Record

WebSocketFrame

Version:

0.0.1

Author:

scx567888

Constructor Summary

Constructors

Constructor	Description
WebSocketFrame(WebSocketOpCode opCode, byte[] payloadData, boolean fin)	Creates an instance of a WebSocketFrame record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
boolean	fin()	Returns the value of the fin record component.
ScxWebSocketCloseInfo	getCloseInfo()
final int	hashCode()	Returns a hash code value for this object.
static WebSocketFrame	of(WebSocketOpCode opCode, byte[] payloadData)
static WebSocketFrame	of(WebSocketOpCode opCode, byte[] payloadData, boolean fin)
WebSocketOpCode	opCode()	Returns the value of the opCode record component.
byte[]	payloadData()	Returns the value of the payloadData record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

WebSocketFrame

public WebSocketFrame(WebSocketOpCode opCode,
 byte[] payloadData,
 boolean fin)

Creates an instance of a WebSocketFrame record class.

Parameters:

opCode - the value for the opCode record component

payloadData - the value for the payloadData record component

fin - the value for the fin record component

Method Details

of

public static WebSocketFrame of(WebSocketOpCode opCode,
 byte[] payloadData,
 boolean fin)

of

public static WebSocketFrame of(WebSocketOpCode opCode,
 byte[] payloadData)

getCloseInfo

public ScxWebSocketCloseInfo getCloseInfo()

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 the compare method from their corresponding wrapper classes.

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.

opCode

public WebSocketOpCode opCode()

Returns the value of the opCode record component.

Returns:

the value of the opCode record component

payloadData

public byte[] payloadData()

Returns the value of the payloadData record component.

Returns:

the value of the payloadData record component

fin

public boolean fin()

Returns the value of the fin record component.

Returns:

the value of the fin record component