Package net.apartium.cocoabeans.commands.virtual

Record Class VirtualCommandDefinition

java.lang.Object

java.lang.Record

net.apartium.cocoabeans.commands.virtual.VirtualCommandDefinition

All Implemented Interfaces:

GenericNode

@Experimental
@AvailableSince("0.0.39")
public record VirtualCommandDefinition(String name, Set<String> aliases, CommandInfo info, Set<VirtualCommandVariant> variants, Map<String,Object> metadata)
extends Record
implements GenericNode

A DTO for commands, a serializable form of commands used to send command definition between applications

See Also:

• VirtualMetadata
• VirtualCommandFactory

Constructor Summary

Constructors

Constructor	Description
VirtualCommandDefinition(String name, Set<String> aliases, CommandInfo info, Set<VirtualCommandVariant> variants, Map<String,Object> metadata)	Create a new virtual command definition instance

Method Summary

Modifier and Type	Method	Description
Set<String>	aliases()	Returns the value of the aliases 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.
CommandInfo	info()	Returns the value of the info record component.
Map<String,Object>	metadata()	Returns the value of the metadata record component.
String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.
Set<VirtualCommandVariant>	variants()	Returns the value of the variants record component.

Methods inherited from class java.lang.Object

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

Constructor Details

VirtualCommandDefinition

public VirtualCommandDefinition(String name,
 Set<String> aliases,
 CommandInfo info,
 Set<VirtualCommandVariant> variants,
 Map<String,Object> metadata)

Create a new virtual command definition instance

Parameters:

name - name

aliases - aliases

info - info

variants - variants

metadata - metadata

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

aliases

public Set<String> aliases()

Returns the value of the aliases record component.

Returns:

the value of the aliases record component

info

public CommandInfo info()

Returns the value of the info record component.

Returns:

the value of the info record component

variants

public Set<VirtualCommandVariant> variants()

Returns the value of the variants record component.

Returns:

the value of the variants record component

metadata

public Map<String,Object> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component