Record Class ConfigFilePayload

java.lang.Object

java.lang.Record

net.neoforged.neoforge.network.payload.ConfigFilePayload

Record Components:

fileName - The name of the config file.

contents - The contents of the config file.

All Implemented Interfaces:

CustomPacketPayload

@Internal
public record ConfigFilePayload(String fileName, byte[] contents)
extends Record
implements CustomPacketPayload

A payload that contains a config file.

This is used to send config files to the client.

Nested Class Summary

Nested classes/interfaces inherited from interface CustomPacketPayload

CustomPacketPayload.FallbackProvider<B>, CustomPacketPayload.Type<T>, CustomPacketPayload.TypeAndCodec<B,T>

Field Summary

Fields

Modifier and Type	Field	Description
private final byte[]	contents	The field for the contents record component.
private final String	fileName	The field for the fileName record component.
static final StreamCodec<FriendlyByteBuf, ConfigFilePayload>	STREAM_CODEC
static final CustomPacketPayload.Type<ConfigFilePayload>	TYPE

Constructor Summary

Constructors

Constructor	Description
ConfigFilePayload(String fileName, byte[] contents)	Creates an instance of a ConfigFilePayload record class.

Method Summary

Modifier and Type	Method	Description
byte[]	contents()	Returns the value of the contents record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	fileName()	Returns the value of the fileName record component.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
CustomPacketPayload.Type<ConfigFilePayload>	type()

Methods inherited from class Object

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

Methods inherited from interface CustomPacketPayload

toVanillaClientbound, toVanillaServerbound

Field Details

fileName

private final String fileName

The field for the fileName record component.

contents

private final byte[] contents

The field for the contents record component.

TYPE

public static final CustomPacketPayload.Type<ConfigFilePayload> TYPE

STREAM_CODEC

public static final StreamCodec<FriendlyByteBuf, ConfigFilePayload> STREAM_CODEC

Constructor Details

ConfigFilePayload

public ConfigFilePayload(String fileName,
 byte[] contents)

Creates an instance of a ConfigFilePayload record class.

Parameters:

fileName - the value for the fileName record component

contents - the value for the contents record component

Method Details

type

public CustomPacketPayload.Type<ConfigFilePayload> type()

Specified by:

type in interface CustomPacketPayload

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.

fileName

public String fileName()

Returns the value of the fileName record component.

Returns:

the value of the fileName record component

contents

public byte[] contents()

Returns the value of the contents record component.

Returns:

the value of the contents record component