Package dev.jorel.commandapi.arguments

Enum Class ArgumentSubType

java.lang.Object

java.lang.Enum<ArgumentSubType>

dev.jorel.commandapi.arguments.ArgumentSubType

All Implemented Interfaces:

Serializable, Comparable<ArgumentSubType>, Constable

public enum ArgumentSubType
extends Enum<ArgumentSubType>

An enum that represents argument subtypes. For example, the EntitySelectorArgument can be split into four arguments:

• One entity
• One player
• Many entities
• Many players

This class is used internally by the CommandAPI, you shouldn't need to use this class yourself.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BIOME_BIOME	A Biome.
BIOME_NAMESPACEDKEY	A Biome.
ENTITYSELECTOR_MANY_ENTITIES	Many entities.
ENTITYSELECTOR_MANY_PLAYERS	Many players.
ENTITYSELECTOR_ONE_ENTITY	A single entity.
ENTITYSELECTOR_ONE_PLAYER	A single player.
POTION_EFFECT_NAMESPACEDKEY	A PotionEffectType.
POTION_EFFECT_POTION_EFFECT	A PotionEffectType.
SCOREHOLDER_MULTIPLE	Multiple scoreholders.
SCOREHOLDER_SINGLE	A ScoreHolder.
SOUND_NAMESPACEDKEY	A Sound.
SOUND_SOUND	A Sound.

Method Summary

Modifier and Type	Method	Description
static ArgumentSubType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ArgumentSubType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ENTITYSELECTOR_ONE_ENTITY

public static final ArgumentSubType ENTITYSELECTOR_ONE_ENTITY

A single entity. Returns a Entity

ENTITYSELECTOR_ONE_PLAYER

public static final ArgumentSubType ENTITYSELECTOR_ONE_PLAYER

A single player. Returns a Player

ENTITYSELECTOR_MANY_ENTITIES

public static final ArgumentSubType ENTITYSELECTOR_MANY_ENTITIES

Many entities. Returns a Collection<Entity>

ENTITYSELECTOR_MANY_PLAYERS

public static final ArgumentSubType ENTITYSELECTOR_MANY_PLAYERS

Many players. Returns a Collection<Player>

BIOME_BIOME

public static final ArgumentSubType BIOME_BIOME

A Biome. Returns a Biome

BIOME_NAMESPACEDKEY

public static final ArgumentSubType BIOME_NAMESPACEDKEY

A Biome. Returns a NamespacedKey

SOUND_SOUND

public static final ArgumentSubType SOUND_SOUND

A Sound. Returns a Sound

SOUND_NAMESPACEDKEY

public static final ArgumentSubType SOUND_NAMESPACEDKEY

A Sound. Returns a NamespacedKey

SCOREHOLDER_SINGLE

public static final ArgumentSubType SCOREHOLDER_SINGLE

A ScoreHolder. Returns a String

SCOREHOLDER_MULTIPLE

public static final ArgumentSubType SCOREHOLDER_MULTIPLE

Multiple scoreholders. Returns a Collection<String>

POTION_EFFECT_POTION_EFFECT

public static final ArgumentSubType POTION_EFFECT_POTION_EFFECT

A PotionEffectType. Returns a PotionEffectType

POTION_EFFECT_NAMESPACEDKEY

public static final ArgumentSubType POTION_EFFECT_NAMESPACEDKEY

A PotionEffectType. Returns a NamespacedKey

Method Details

values

public static ArgumentSubType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ArgumentSubType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null