dev.rollczi.litecommands.invalidusage

Enum InvalidUsage.Cause

java.lang.Object

java.lang.Enum<InvalidUsage.Cause>

dev.rollczi.litecommands.invalidusage.InvalidUsage.Cause

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<InvalidUsage.Cause>

Enclosing class:

InvalidUsage<SENDER>

public static enum InvalidUsage.Cause
extends java.lang.Enum<InvalidUsage.Cause>

Enum Constant Summary

Enum Constants

Enum Constant and Description
INVALID_ARGUMENT When input is invalid e.g.
MISSING_ARGUMENT When input is valid but not enough e.g.
MISSING_PART_OF_ARGUMENT When input is valid but not enough (part of argument is missing) e.g.
TOO_MANY_ARGUMENTS When input is valid but too much e.g.
UNKNOWN_COMMAND When command is not found

Method Summary

Modifier and Type	Method and Description
static InvalidUsage.Cause	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static InvalidUsage.Cause[]	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

UNKNOWN_COMMAND

public static final InvalidUsage.Cause UNKNOWN_COMMAND

When command is not found

INVALID_ARGUMENT

public static final InvalidUsage.Cause INVALID_ARGUMENT

When input is invalid e.g.

 command: /command [int]
 input: /command text
 

MISSING_ARGUMENT

public static final InvalidUsage.Cause MISSING_ARGUMENT

When input is valid but not enough e.g.

 command: /command [text] [x y z]
 input: /command text
 

MISSING_PART_OF_ARGUMENT

public static final InvalidUsage.Cause MISSING_PART_OF_ARGUMENT

When input is valid but not enough (part of argument is missing) e.g.

 command: /command [text] [x y z]
 input: /command text 10 20
 

TOO_MANY_ARGUMENTS

public static final InvalidUsage.Cause TOO_MANY_ARGUMENTS

When input is valid but too much e.g.

 command: /command [text] [x y z]
 input: /command text 10 20 30 40
 

Method Detail

values

public static InvalidUsage.Cause[] 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 (InvalidUsage.Cause c : InvalidUsage.Cause.values())
    System.out.println(c);

Returns:

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

valueOf

public static InvalidUsage.Cause 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