Package org.moddingx.libx.network

Record Class NetworkX.Protocol

java.lang.Object

java.lang.Record

org.moddingx.libx.network.NetworkX.Protocol

Record Components:

version - The protocol version. This must be equal on client and server

client - The behaviour for the client

server - The behaviour for the dedicated server

Enclosing class:

NetworkX

public static record NetworkX.Protocol(String version, NetworkX.ProtocolSide client, NetworkX.ProtocolSide server)
extends Record

A protocol defines when a connection is accepted or rejected.

Constructor Summary

Constructors

Constructor	Description
Protocol(String version, NetworkX.ProtocolSide client, NetworkX.ProtocolSide server)	Creates an instance of a Protocol record class.

Method Summary

Modifier and Type	Method	Description
NetworkX.ProtocolSide	client()	Returns the value of the client record component.
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.
static NetworkX.Protocol	of(String version)	Creates a new protocol with the given version, that is required on both sides.
NetworkX.ProtocolSide	server()	Returns the value of the server record component.
final String	toString()	Returns a string representation of this record class.
String	version()	Returns the value of the version record component.

Methods inherited from class java.lang.Object

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

Constructor Details

Protocol

public Protocol(String version,
 NetworkX.ProtocolSide client,
 NetworkX.ProtocolSide server)

Creates an instance of a Protocol record class.

Parameters:

version - the value for the version record component

client - the value for the client record component

server - the value for the server record component

Method Details

of

public static NetworkX.Protocol of(String version)

Creates a new protocol with the given version, that is required on both sides.

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.

version

public String version()

Returns the value of the version record component.

Returns:

the value of the version record component

client

public NetworkX.ProtocolSide client()

Returns the value of the client record component.

Returns:

the value of the client record component

server

public NetworkX.ProtocolSide server()

Returns the value of the server record component.

Returns:

the value of the server record component