org.neo4j.shell

Enum OptionValueType

java.lang.Object

java.lang.Enum<OptionValueType>

org.neo4j.shell.OptionValueType

All Implemented Interfaces:

Serializable, Comparable<OptionValueType>

public enum OptionValueType
extends Enum<OptionValueType>

Whether or not options are expected to be supplied with a value.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAY There may be a value supplied.
MUST There must be a supplied value.
NONE No value is to be specified.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final OptionValueType NONE

No value is to be specified.

MAY

public static final OptionValueType MAY

There may be a value supplied.

MUST

public static final OptionValueType MUST

There must be a supplied value.

Method Detail

values

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

Returns:

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

valueOf

public static OptionValueType valueOf(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:

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

NullPointerException - if the argument is null

getDescription

public String getDescription()

Returns:

the description for this option.