Package net.neoforged.neoforge.network.negotiation

Record Class NegotiationResult

java.lang.Object

java.lang.Record

net.neoforged.neoforge.network.negotiation.NegotiationResult

Record Components:

components - The successfully negotiated components. Is empty when success() is false.

success - Whether the negotiation was successful.

failureReasons - The reasons for the failure of the negotiation. Is empty when success() is true.

@Internal
public record NegotiationResult(List<NegotiatedNetworkComponent> components, boolean success, Map<ResourceLocation,Component> failureReasons)
extends Record

Represents the result of a negotiation of network components.

Field Summary

Fields

Modifier and Type	Field	Description
private final List<NegotiatedNetworkComponent>	components	The field for the components record component.
private final Map<ResourceLocation,Component>	failureReasons	The field for the failureReasons record component.
private final boolean	success	The field for the success record component.

Constructor Summary

Constructors

Constructor	Description
NegotiationResult(List<NegotiatedNetworkComponent> components, boolean success, Map<ResourceLocation,Component> failureReasons)	Creates an instance of a NegotiationResult record class.

Method Summary

Modifier and Type	Method	Description
List<NegotiatedNetworkComponent>	components()	Returns the value of the components record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Map<ResourceLocation,Component>	failureReasons()	Returns the value of the failureReasons record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	success()	Returns the value of the success record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Field Details

components

private final List<NegotiatedNetworkComponent> components

The field for the components record component.

success

private final boolean success

The field for the success record component.

failureReasons

private final Map<ResourceLocation,Component> failureReasons

The field for the failureReasons record component.

Constructor Details

NegotiationResult

public NegotiationResult(List<NegotiatedNetworkComponent> components,
 boolean success,
 Map<ResourceLocation,Component> failureReasons)

Creates an instance of a NegotiationResult record class.

Parameters:

components - the value for the components record component

success - the value for the success record component

failureReasons - the value for the failureReasons 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 '=='.

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.

components

public List<NegotiatedNetworkComponent> components()

Returns the value of the components record component.

Returns:

the value of the components record component

success

public boolean success()

Returns the value of the success record component.

Returns:

the value of the success record component

failureReasons

public Map<ResourceLocation,Component> failureReasons()

Returns the value of the failureReasons record component.

Returns:

the value of the failureReasons record component