me.vaperion.blade.annotation.parameter

Enum Opt.Type

java.lang.Object

java.lang.Enum<Opt.Type>

me.vaperion.blade.annotation.parameter.Opt.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Opt.Type>

Enclosing class:

Opt

public static enum Opt.Type
extends java.lang.Enum<Opt.Type>

The type of the optional value.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM Use the custom value specified by Opt.custom().
EMPTY Use null as the default value.
EMPTY_OR_CUSTOM Use either EMPTY or CUSTOM based on whether a custom value is provided.
SENDER Use the command sender as the default value (for player types).

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EMPTY_OR_CUSTOM

public static final Opt.Type EMPTY_OR_CUSTOM

Use either EMPTY or CUSTOM based on whether a custom value is provided.

EMPTY

public static final Opt.Type EMPTY

Use null as the default value.

For primitive types, this will use the default value of the primitive (e.g., 0 for int, false for boolean).

SENDER

public static final Opt.Type SENDER

Use the command sender as the default value (for player types).

For non-player types, this will result in an error at command execution.

CUSTOM

public static final Opt.Type CUSTOM

Use the custom value specified by Opt.custom().

This will be parsed according to the parameter type.

Method Detail

values

public static Opt.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Opt.Type c : Opt.Type.values())
    System.out.println(c);

Returns:

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

valueOf

public static Opt.Type valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null