Package net.apartium.cocoabeans.commands.parsers

Enum Class Scope

java.lang.Object

java.lang.Enum<Scope>

net.apartium.cocoabeans.commands.parsers.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>, Constable

@AvailableSince("0.0.30")
public enum Scope
extends Enum<Scope>

Represents the scope of a parser factory

See Also:

• ParserFactory

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
ALL	Scoped to either scopes
CLASS	Scoped to an entire command class
VARIANT	Scoped to a specific sub command

Method Summary

Modifier and Type	Method	Description
boolean	isClass()	Whether this scope applies to a class
boolean	isVariant()	Whether this scope applies to a variant
static Scope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Scope[]	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

VARIANT

public static final Scope VARIANT

Scoped to a specific sub command

CLASS

public static final Scope CLASS

Scoped to an entire command class

ALL

public static final Scope ALL

Scoped to either scopes

See Also:

• VARIANT
• CLASS

Method Details

values

public static Scope[] 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 Scope 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

isClass

public boolean isClass()

Whether this scope applies to a class

Returns:

true if applies to a class, else false

See Also:

• CLASS
• ALL

isVariant

public boolean isVariant()

Whether this scope applies to a variant

Returns:

true if applies to a variant, else false

See Also:

• VARIANT
• ALL