Record Class Chat

java.lang.Object

java.lang.Record

net.flectone.pulse.module.message.chat.model.Chat

Record Components:

name - the chat name, or null when no chat matched

config - the chat settings, or null

permission - the chat permissions, or null

public record Chat(@Nullable String name, @Nullable Message.Chat.Type config, @Nullable Permission.Message.Chat.Type permission)
extends Record

One configured chat, together with the settings and permissions attached to it.

Constructor Summary

Constructors

Constructor	Description
Chat(@Nullable String name, @Nullable Message.Chat.Type config, @Nullable Permission.Message.Chat.Type permission)	Creates an instance of a Chat record class.

Method Summary

Modifier and Type	Method	Description
@Nullable Message.Chat.Type	config()	Returns the value of the config record component.
Pair<Cooldown, PermissionSetting>	cooldown()	The chat's cooldown with the permission that bypasses it.
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.
@Nullable String	name()	Returns the value of the name record component.
@Nullable Permission.Message.Chat.Type	permission()	Returns the value of the permission record component.
Pair<Sound, PermissionSetting>	sound()	The chat's sound with the permission needed to hear it.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

Chat

public Chat(@Nullable String name,
 @Nullable Message.Chat.Type config,
 @Nullable Permission.Message.Chat.Type permission)

Creates an instance of a Chat record class.

Parameters:

name - the value for the name record component

config - the value for the config record component

permission - the value for the permission record component

Method Details

cooldown

public Pair<Cooldown, PermissionSetting> cooldown()

The chat's cooldown with the permission that bypasses it.

Returns:

the cooldown and its bypass permission

sound

public Pair<Sound, PermissionSetting> sound()

The chat's sound with the permission needed to hear it.

Returns:

the sound and its permission

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.

name

public @Nullable String name()

Returns the value of the name record component.

Returns:

the value of the name record component

config

public @Nullable Message.Chat.Type config()

Returns the value of the config record component.

Returns:

the value of the config record component

permission

public @Nullable Permission.Message.Chat.Type permission()

Returns the value of the permission record component.

Returns:

the value of the permission record component