Package dev.rollczi.litecommands.invalidusage

Enum Class InvalidUsage.Cause

java.lang.Object

java.lang.Enum<InvalidUsage.Cause>

dev.rollczi.litecommands.invalidusage.InvalidUsage.Cause

All Implemented Interfaces:

Serializable, Comparable<InvalidUsage.Cause>, Constable

Enclosing class:

InvalidUsage<SENDER>

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

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
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	Description
static InvalidUsage.Cause	valueOf(String name)	Returns the enum constant of this class with the specified name.
static InvalidUsage.Cause[]	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

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 Details

values

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