Record Class ChatTypeDefinition

java.lang.Object

java.lang.Record

fr.fidorial.chat.ChatTypeDefinition

Record Components:

typedKey - the key of the chat type, typed against the minecraft:chat_type registry

chat - how the message is shown in the chat log

narration - how the message is read out for narration/accessibility

All Implemented Interfaces:

ChatType

public record ChatTypeDefinition(TypedKey<ChatTypeDefinition> typedKey, ChatTypeDecoration chat, ChatTypeDecoration narration)
extends Record
implements ChatType

A complete chat type definition, ready to be sent to clients.

Since:

0.1.0

Nested Class Summary

Nested classes/interfaces inherited from interface ChatType

ChatType.Bound

Field Summary

Fields inherited from interface ChatType

CHAT, EMOTE_COMMAND, MSG_COMMAND_INCOMING, MSG_COMMAND_OUTGOING, SAY_COMMAND, TEAM_MSG_COMMAND_INCOMING, TEAM_MSG_COMMAND_OUTGOING

Constructor Summary

Constructors

Constructor	Description
ChatTypeDefinition(TypedKey<ChatTypeDefinition> typedKey, ChatTypeDecoration chat, ChatTypeDecoration narration)	Creates an instance of a ChatTypeDefinition record class.

Method Summary

Modifier and Type	Method	Description
static ChatTypeBuilder	builder(ChatTypeDefinition definition)	Returns a new builder pre-filled with the values of definition.
static ChatTypeBuilder	builder(TypedKey<ChatTypeDefinition> key)	Returns a new builder for the chat type identified by key.
ChatTypeDecoration	chat()	Returns the value of the chat 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.
Key	key()
ChatTypeDecoration	narration()	Returns the value of the narration record component.
final String	toString()	Returns a string representation of this record class.
TypedKey<ChatTypeDefinition>	typedKey()	Returns the value of the typedKey record component.

Methods inherited from class Object

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

Methods inherited from interface ChatType

bind, bind

Constructor Details

ChatTypeDefinition

public ChatTypeDefinition(TypedKey<ChatTypeDefinition> typedKey,
 ChatTypeDecoration chat,
 ChatTypeDecoration narration)

Creates an instance of a ChatTypeDefinition record class.

Parameters:

typedKey - the value for the typedKey record component

chat - the value for the chat record component

narration - the value for the narration record component

Method Details

builder

@Contract(value="_ -> new",
          pure=true)
public static ChatTypeBuilder builder(TypedKey<ChatTypeDefinition> key)

Returns a new builder for the chat type identified by key.

Parameters:

key - the namespaced identifier of the chat type

Returns:

a new builder for the chat type identified by key

builder

@Contract(value="_ -> new",
          pure=true)
public static ChatTypeBuilder builder(ChatTypeDefinition definition)

Returns a new builder pre-filled with the values of definition.

Parameters:

definition - the definition to copy

Returns:

a new builder pre-filled with the values of definition

key

public Key key()

Specified by:

key in interface ChatType

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.

typedKey

public TypedKey<ChatTypeDefinition> typedKey()

Returns the value of the typedKey record component.

Returns:

the value of the typedKey record component

chat

public ChatTypeDecoration chat()

Returns the value of the chat record component.

Returns:

the value of the chat record component

narration

public ChatTypeDecoration narration()

Returns the value of the narration record component.

Returns:

the value of the narration record component