Record Class KeywordDefinition

java.lang.Object

java.lang.Record

fr.dreamin.dreamvoice.api.speech.model.KeywordDefinition

Record Components:

id - unique key of the keyword action

words - list of words or phrases that trigger this keyword

permission - optional permission required by the player to trigger

public record KeywordDefinition(@NotNull String id, @NotNull List<String> words, @Nullable String permission)
extends Record

Model representing a keyword target and its spoken variants/aliases.

Constructor Summary

Constructors

Constructor	Description
KeywordDefinition(@NotNull String id, @NotNull List<String> words, @Nullable String permission)	Creates an instance of a KeywordDefinition record class.

Method Summary

Modifier and Type	Method	Description
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.
@NotNull String	id()	Returns the value of the id record component.
@Nullable String	permission()	Returns the value of the permission record component.
final String	toString()	Returns a string representation of this record class.
@NotNull List<String>	words()	Returns the value of the words record component.

Methods inherited from class Object

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

Constructor Details

KeywordDefinition

public KeywordDefinition(@NotNull
 @NotNull String id,
 @NotNull
 @NotNull List<String> words,
 @Nullable
 @Nullable String permission)

Creates an instance of a KeywordDefinition record class.

Parameters:

id - the value for the id record component

words - the value for the words record component

permission - the value for the permission 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. 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.

id

@NotNull
public @NotNull String id()

Returns the value of the id record component.

Returns:

the value of the id record component

words

@NotNull
public @NotNull List<String> words()

Returns the value of the words record component.

Returns:

the value of the words record component

permission

@Nullable
public @Nullable String permission()

Returns the value of the permission record component.

Returns:

the value of the permission record component