Record Class CommandSpec

java.lang.Object

java.lang.Record

dev.plex.command.CommandSpec

Record Components:

name - primary command name

description - short command description

usage - command usage text; <command> is replaced with the command name

aliases - alternate root labels for the command

permission - permission node required to use the command

requiredSource - source restriction for command execution

public record CommandSpec(String name, String description, String usage, List<String> aliases, String permission, RequiredCommandSource requiredSource)
extends Record

Defines a Plex command. Command names and aliases can contain lowercase letters, digits, colons, underscores, and hyphens.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CommandSpec.Builder	Builder for command specs.

Constructor Summary

Constructors

Constructor	Description
CommandSpec(String name, String description, String usage, List<String> aliases, String permission, RequiredCommandSource requiredSource)	Creates and validates command data.

Method Summary

Modifier and Type	Method	Description
List<String>	aliases()	Returns the value of the aliases record component.
static CommandSpec.Builder	builder(String name)	Creates a command spec builder for the given primary name.
String	description()	Returns the value of the description 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.
String	name()	Returns the value of the name record component.
String	permission()	Returns the value of the permission record component.
RequiredCommandSource	requiredSource()	Returns the value of the requiredSource record component.
String	resolvedUsage()	Returns usage text with the command placeholder expanded.
final String	toString()	Returns a string representation of this record class.
String	usage()	Returns the value of the usage record component.

Methods inherited from class Object

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

Constructor Details

CommandSpec

public CommandSpec(String name,
 String description,
 String usage,
 List<String> aliases,
 String permission,
 RequiredCommandSource requiredSource)

Creates and validates command data.

Method Details

builder

public static CommandSpec.Builder builder(String name)

Creates a command spec builder for the given primary name.

Parameters:

name - primary command name

Returns:

command spec builder

resolvedUsage

public String resolvedUsage()

Returns usage text with the command placeholder expanded.

Returns:

command usage text for this command

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 String name()

Returns the value of the name record component.

Returns:

the value of the name record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

usage

public String usage()

Returns the value of the usage record component.

Returns:

the value of the usage record component

aliases

public List<String> aliases()

Returns the value of the aliases record component.

Returns:

the value of the aliases record component

permission

public String permission()

Returns the value of the permission record component.

Returns:

the value of the permission record component

requiredSource

public RequiredCommandSource requiredSource()

Returns the value of the requiredSource record component.

Returns:

the value of the requiredSource record component