Package dev.jorel.commandapi

Record Class MockCommandSource

java.lang.Object

java.lang.Record

dev.jorel.commandapi.MockCommandSource

Record Components:

bukkitSender - The Bukkit CommandSender this source represents.

location - The Location where this source is running the command from.

entity - The Entity this source is running the command as.

public record MockCommandSource(org.bukkit.command.CommandSender bukkitSender, org.bukkit.Location location, org.bukkit.entity.Entity entity)
extends Record

An NMS independent implementation of CommandSourceStack. Used by Brigadier when parsing and executing commands.

Constructor Summary

Constructors

Constructor	Description
MockCommandSource(org.bukkit.command.CommandSender bukkitSender)
MockCommandSource(org.bukkit.command.CommandSender bukkitSender, org.bukkit.Location location, org.bukkit.entity.Entity entity)	Creates an instance of a MockCommandSource record class.

Method Summary

Modifier and Type	Method	Description
org.bukkit.command.CommandSender	bukkitSender()	Returns the value of the bukkitSender record component.
org.bukkit.entity.Entity	entity()	Returns the value of the entity 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.
org.bukkit.Location	location()	Returns the value of the location 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

MockCommandSource

public MockCommandSource(org.bukkit.command.CommandSender bukkitSender)

MockCommandSource

public MockCommandSource(org.bukkit.command.CommandSender bukkitSender,
 org.bukkit.Location location,
 org.bukkit.entity.Entity entity)

Creates an instance of a MockCommandSource record class.

Parameters:

bukkitSender - the value for the bukkitSender record component

location - the value for the location record component

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

bukkitSender

public org.bukkit.command.CommandSender bukkitSender()

Returns the value of the bukkitSender record component.

Returns:

the value of the bukkitSender record component

location

public org.bukkit.Location location()

Returns the value of the location record component.

Returns:

the value of the location record component

entity

public org.bukkit.entity.Entity entity()

Returns the value of the entity record component.

Returns:

the value of the entity record component