org.crsh.command

Enum DescriptionFormat

java.lang.Object

java.lang.Enum<DescriptionFormat>

org.crsh.command.DescriptionFormat

All Implemented Interfaces:

Serializable, Comparable<DescriptionFormat>

public enum DescriptionFormat
extends Enum<DescriptionFormat>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DESCRIBE The command descriptiion in one line.
MAN The command manual.
USAGE The command usage.

Method Summary

Methods

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

DESCRIBE

public static final DescriptionFormat DESCRIBE

The command descriptiion in one line.

USAGE

public static final DescriptionFormat USAGE

The command usage.

MAN

public static final DescriptionFormat MAN

The command manual.

Method Detail

values

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

Returns:

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

valueOf

public static DescriptionFormat 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