Record Class CommandInfo

java.lang.Object

java.lang.Record

eu.cloudnetservice.driver.command.CommandInfo

Record Components:

name - the root name of the command.

aliases - all aliases of the root command.

permission - the permission that is needed to execute the command.

description - the description of the command which is used for the help command.

docsUrl - the url to the documentation of the command.

usage - the correct syntax usages for each sub command.

All Implemented Interfaces:

Named

public record CommandInfo(@NonNull String name, @NonNull Set<String> aliases, @NonNull String permission, @NonNull String description, @Nullable String docsUrl, @NonNull List<String> usage)
extends Record
implements Named

Represents a command information object which holds all information for a single command that is registered on a node.

The command info has one main identification point. It's identified by the name of the command. The command represented by the command info is always the root of the command. Subcommands don't have an own command info, every needed information is stored in the root command info. The usage contains the syntax for every possible command, here are subcommands included too.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private final @NonNull Set<String>	aliases	The field for the aliases record component.
private final @NonNull String	description	The field for the description record component.
private final @Nullable String	docsUrl	The field for the docsUrl record component.
private final @NonNull String	name	The field for the name record component.
private final @NonNull String	permission	The field for the permission record component.
private final @NonNull List<String>	usage	The field for the usage record component.

Constructor Summary

Constructors

Constructor	Description
CommandInfo(@NonNull String name, @NonNull Set<String> aliases, @NonNull String permission, @NonNull String description, @Nullable String docsUrl, @NonNull List<String> usage)	Creates an instance of a CommandInfo record class.

Method Summary

Modifier and Type	Method	Description
@NonNull Set<String>	aliases()	Returns the value of the aliases record component.
@NonNull String	description()	Returns the value of the description record component.
@Nullable String	docsUrl()	Returns the value of the docsUrl record component.
boolean	equals(@Nullable Object other)
int	hashCode()
@NonNull String	joinNameToAliases(@NonNull String separator)	Joins the name of the registered command and the specified aliases into one String seperated by the separator.
@NonNull String	name()	Returns the value of the name record component.
@NonNull String	permission()	Returns the value of the permission record component.
final String	toString()	Returns a string representation of this record class.
@NonNull List<String>	usage()	Returns the value of the usage record component.

Methods inherited from class java.lang.Object

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

Field Details

name

@NonNull
private final @NonNull String name

The field for the name record component.

aliases

@NonNull
private final @NonNull Set<String> aliases

The field for the aliases record component.

permission

@NonNull
private final @NonNull String permission

The field for the permission record component.

description

@NonNull
private final @NonNull String description

The field for the description record component.

docsUrl

@Nullable
private final @Nullable String docsUrl

The field for the docsUrl record component.

usage

@NonNull
private final @NonNull List<String> usage

The field for the usage record component.

Constructor Details

CommandInfo

public CommandInfo(@NonNull
 @NonNull String name,
 @NonNull
 @NonNull Set<String> aliases,
 @NonNull
 @NonNull String permission,
 @NonNull
 @NonNull String description,
 @Nullable
 @Nullable String docsUrl,
 @NonNull
 @NonNull List<String> usage)

Creates an instance of a CommandInfo record class.

Parameters:

name - the value for the name record component

aliases - the value for the aliases record component

permission - the value for the permission record component

description - the value for the description record component

docsUrl - the value for the docsUrl record component

usage - the value for the usage record component

Method Details

joinNameToAliases

@NonNull
public @NonNull String joinNameToAliases(@NonNull
 @NonNull String separator)

Joins the name of the registered command and the specified aliases into one String seperated by the separator.

Parameters:

separator - the separator to join with.

Returns:

the joined String with the name and all aliases.

Throws:

NullPointerException - if separator is null.

equals

public boolean equals(@Nullable
 @Nullable Object other)

Specified by:

equals in class Record

hashCode

public int hashCode()

Specified by:

hashCode in class Record

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

name

@NonNull
public @NonNull String name()

Returns the value of the name record component.

Specified by:

name in interface Named

Returns:

the value of the name record component

aliases

@NonNull
public @NonNull Set<String> aliases()

Returns the value of the aliases record component.

Returns:

the value of the aliases record component

permission

@NonNull
public @NonNull String permission()

Returns the value of the permission record component.

Returns:

the value of the permission record component

description

@NonNull
public @NonNull String description()

Returns the value of the description record component.

Returns:

the value of the description record component

docsUrl

@Nullable
public @Nullable String docsUrl()

Returns the value of the docsUrl record component.

Returns:

the value of the docsUrl record component

usage

@NonNull
public @NonNull List<String> usage()

Returns the value of the usage record component.

Returns:

the value of the usage record component