Record Class CommandAction

java.lang.Object

java.lang.Record

dev.despical.pixelpainter.command.CommandAction

Record Components:

name - canonical action and help-message suffix

permission - permission suffix below pp

syntax - displayed syntax without the root command

suggestion - suggested text without the root command

group - help section the command belongs to

public record CommandAction(String name, String permission, String syntax, String suggestion, CommandAction.Group group)
extends Record

Describes a command for permission filtering, grouped help and suggestions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CommandAction.Group	Help sections, declared in presentation order.

Constructor Summary

Constructors

Constructor	Description
CommandAction(String name, String permission, String syntax, String suggestion, CommandAction.Group group)	Creates an instance of a CommandAction record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
CommandAction.Group	group()	Returns the value of the group record component.
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.
String	suggestion()	Returns the value of the suggestion record component.
String	syntax()	Returns the value of the syntax record component.
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

CommandAction

public CommandAction(String name,
 String permission,
 String syntax,
 String suggestion,
 CommandAction.Group group)

Creates an instance of a CommandAction record class.

Parameters:

name - the value for the name record component

permission - the value for the permission record component

syntax - the value for the syntax record component

suggestion - the value for the suggestion record component

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

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

permission

public String permission()

Returns the value of the permission record component.

Returns:

the value of the permission record component

syntax

public String syntax()

Returns the value of the syntax record component.

Returns:

the value of the syntax record component

suggestion

public String suggestion()

Returns the value of the suggestion record component.

Returns:

the value of the suggestion record component

group

public CommandAction.Group group()

Returns the value of the group record component.

Returns:

the value of the group record component