Package org.teleight.teleightbots.commands.builder

Record Class CommandSyntax

java.lang.Object

java.lang.Record

org.teleight.teleightbots.commands.builder.CommandSyntax

Record Components:

condition - interface that checks if a command can be executed via certain conditions

executor - the command executor

args - array of command arguments

public record CommandSyntax(@Nullable CommandCondition condition, @NotNull CommandExecutor executor, @NotNull Argument<?>[] args)
extends Record

Class representing a command syntax. Every command can have multiple syntaxes, and this class is a representation of each syntax

Constructor Summary

Constructors

Constructor	Description
CommandSyntax(@Nullable CommandCondition condition, @NotNull CommandExecutor executor, @NotNull Argument<?>[] args)	Creates an instance of a CommandSyntax record class.

Method Summary

Modifier and Type	Method	Description
@NotNull Argument<?>[]	args()	Returns the value of the args record component.
@Nullable CommandCondition	condition()	Returns the value of the condition record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull CommandExecutor	executor()	Returns the value of the executor record component.
final int	hashCode()	Returns a hash code value for this object.
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

Constructor Details

CommandSyntax

public CommandSyntax(@Nullable
 @Nullable CommandCondition condition,
 @NotNull
 @NotNull CommandExecutor executor,
 @NotNull
 @NotNull Argument<?>[] args)

Creates an instance of a CommandSyntax record class.

Parameters:

condition - the value for the condition record component

executor - the value for the executor record component

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

condition

@Nullable
public @Nullable CommandCondition condition()

Returns the value of the condition record component.

Returns:

the value of the condition record component

executor

@NotNull
public @NotNull CommandExecutor executor()

Returns the value of the executor record component.

Returns:

the value of the executor record component

args

@NotNull
public @NotNull Argument<?>[] args()

Returns the value of the args record component.

Returns:

the value of the args record component