Record Class NegotiableNetworkComponent

java.lang.Object

java.lang.Record

net.neoforged.neoforge.network.negotiation.NegotiableNetworkComponent

Record Components:

id - The id of the payload type.

version - The version of the payload type.

flow - The flow of the payload type.

optional - Whether the payload type is optional.

@Internal
public record NegotiableNetworkComponent(Identifier id, String version, Optional<PacketFlow> flow, boolean optional)
extends Record

Represents the input to the negotiation process for a single network payload type.

Field Summary

Fields

Modifier and Type	Field	Description
private final Optional<PacketFlow>	flow	The field for the flow record component.
private final Identifier	id	The field for the id record component.
private final boolean	optional	The field for the optional record component.
private final String	version	The field for the version record component.

Constructor Summary

Constructors

Constructor	Description
NegotiableNetworkComponent(Identifier id, String version, Optional<PacketFlow> flow, boolean optional)	Creates an instance of a NegotiableNetworkComponent record class.
NegotiableNetworkComponent(ModdedNetworkQueryComponent query)
NegotiableNetworkComponent(PayloadRegistration<?> reg)

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Optional<PacketFlow>	flow()	Returns the value of the flow record component.
final int	hashCode()	Returns a hash code value for this object.
Identifier	id()	Returns the value of the id record component.
boolean	optional()	Returns the value of the optional 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 Object

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

Field Details

id

private final Identifier id

The field for the id record component.

version

private final String version

The field for the version record component.

flow

private final Optional<PacketFlow> flow

The field for the flow record component.

optional

private final boolean optional

The field for the optional record component.

Constructor Details

NegotiableNetworkComponent

public NegotiableNetworkComponent(PayloadRegistration<?> reg)

NegotiableNetworkComponent

public NegotiableNetworkComponent(ModdedNetworkQueryComponent query)

NegotiableNetworkComponent

public NegotiableNetworkComponent(Identifier id,
 String version,
 Optional<PacketFlow> flow,
 boolean optional)

Creates an instance of a NegotiableNetworkComponent record class.

Parameters:

id - the value for the id record component

version - the value for the version record component

flow - the value for the flow record component

optional - the value for the optional record component

Method Details

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.

id

public Identifier id()

Returns the value of the id record component.

Returns:

the value of the id record component

version

public String version()

Returns the value of the version record component.

Returns:

the value of the version record component

flow

public Optional<PacketFlow> flow()

Returns the value of the flow record component.

Returns:

the value of the flow record component

optional

public boolean optional()

Returns the value of the optional record component.

Returns:

the value of the optional record component