Record Class CommandSourceStack

java.lang.Object

java.lang.Record

com.soulfiremc.server.command.CommandSourceStack

public record CommandSourceStack(SoulFireServer soulFire, SoulFireUser source, @Nullable Set<UUID> instanceIds, @Nullable Set<UUID> botIds)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
static final Predicate<CommandSourceStack>	IS_ADMIN

Constructor Summary

Constructors

Constructor	Description
CommandSourceStack(SoulFireServer soulFire, SoulFireUser source, @Nullable Set<UUID> instanceIds, @Nullable Set<UUID> botIds)	Creates an instance of a CommandSourceStack record class.

Method Summary

Modifier and Type	Method	Description
@Nullable Set<UUID>	botIds()	Returns the value of the botIds record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<BotConnection>	getGlobalVisibleBots()
List<BotConnection>	getInstanceVisibleBots(InstanceManager instance)
List<InstanceManager>	getVisibleInstances()
final int	hashCode()	Returns a hash code value for this object.
@Nullable Set<UUID>	instanceIds()	Returns the value of the instanceIds record component.
static CommandSourceStack	ofInstance(SoulFireServer soulFire, SoulFireUser source, Set<UUID> instanceIds)
static CommandSourceStack	ofUnrestricted(SoulFireServer soulFire, SoulFireUser source)
SoulFireServer	soulFire()	Returns the value of the soulFire record component.
SoulFireUser	source()	Returns the value of the source record component.
final String	toString()	Returns a string representation of this record class.
CommandSourceStack	withBotIds(Set<UUID> botIds)
CommandSourceStack	withInstanceIds(Set<UUID> instanceIds)

Methods inherited from class Object

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

Field Details

IS_ADMIN

public static final Predicate<CommandSourceStack> IS_ADMIN

Constructor Details

CommandSourceStack

public CommandSourceStack(SoulFireServer soulFire,
 SoulFireUser source,
 @Nullable Set<UUID> instanceIds,
 @Nullable Set<UUID> botIds)

Creates an instance of a CommandSourceStack record class.

Parameters:

soulFire - the value for the soulFire record component

source - the value for the source record component

instanceIds - the value for the instanceIds record component

botIds - the value for the botIds record component

Method Details

ofUnrestricted

public static CommandSourceStack ofUnrestricted(SoulFireServer soulFire,
 SoulFireUser source)

ofInstance

public static CommandSourceStack ofInstance(SoulFireServer soulFire,
 SoulFireUser source,
 Set<UUID> instanceIds)

withInstanceIds

public CommandSourceStack withInstanceIds(Set<UUID> instanceIds)

withBotIds

public CommandSourceStack withBotIds(Set<UUID> botIds)

getVisibleInstances

public List<InstanceManager> getVisibleInstances()

getInstanceVisibleBots

public List<BotConnection> getInstanceVisibleBots(InstanceManager instance)

getGlobalVisibleBots

public List<BotConnection> getGlobalVisibleBots()

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.

soulFire

public SoulFireServer soulFire()

Returns the value of the soulFire record component.

Returns:

the value of the soulFire record component

source

public SoulFireUser source()

Returns the value of the source record component.

Returns:

the value of the source record component

instanceIds

public @Nullable Set<UUID> instanceIds()

Returns the value of the instanceIds record component.

Returns:

the value of the instanceIds record component

botIds

public @Nullable Set<UUID> botIds()

Returns the value of the botIds record component.

Returns:

the value of the botIds record component