Package dev.jorel.commandapi.executors

Record Class BukkitExecutionInfo<Sender>

java.lang.Object

java.lang.Record

dev.jorel.commandapi.executors.BukkitExecutionInfo<Sender>

Type Parameters:

Sender - The type of the sender of a command this BukkitExecutionInfo belongs to

All Implemented Interfaces:

ExecutionInfo<Sender,BukkitCommandSender<? extends Sender>>

public record BukkitExecutionInfo<Sender>(Sender sender, BukkitCommandSender<? extends Sender> senderWrapper, CommandArguments args)
extends Record
implements ExecutionInfo<Sender,BukkitCommandSender<? extends Sender>>

This record represents a BukkitExecutionInfo for a command. It provides the sender of a command, as well as it's arguments

Constructor Summary

Constructors

Constructor	Description
BukkitExecutionInfo(Sender sender, BukkitCommandSender<? extends Sender> senderWrapper, CommandArguments args)	Creates an instance of a BukkitExecutionInfo record class.

Method Summary

Modifier and Type	Method	Description
CommandArguments	args()	Returns the value of the args 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.
Sender	sender()	Returns the value of the sender record component.
BukkitCommandSender<? extends Sender>	senderWrapper()	Returns the value of the senderWrapper record component.
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

BukkitExecutionInfo

public BukkitExecutionInfo(Sender sender,
 BukkitCommandSender<? extends Sender> senderWrapper,
 CommandArguments args)

Creates an instance of a BukkitExecutionInfo record class.

Parameters:

sender - the value for the sender record component

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

sender

public Sender sender()

Returns the value of the sender record component.

Specified by:

sender in interface ExecutionInfo<Sender,BukkitCommandSender<? extends Sender>>

Returns:

the value of the sender record component

senderWrapper

public BukkitCommandSender<? extends Sender> senderWrapper()

Returns the value of the senderWrapper record component.

Specified by:

senderWrapper in interface ExecutionInfo<Sender,BukkitCommandSender<? extends Sender>>

Returns:

the value of the senderWrapper record component

args

public CommandArguments args()

Returns the value of the args record component.

Specified by:

args in interface ExecutionInfo<Sender,BukkitCommandSender<? extends Sender>>

Returns:

the value of the args record component