Package org.jline.shell

Enum Class CommandLine.Type

java.lang.Object

java.lang.Enum<CommandLine.Type>

org.jline.shell.CommandLine.Type

All Implemented Interfaces:

Serializable, Comparable<CommandLine.Type>, Constable

Enclosing class:

CommandLine

public static enum CommandLine.Type
extends Enum<CommandLine.Type>

The type of description that should be displayed.

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
COMMAND	Full command description
METHOD	Method/function parameter description
SYNTAX	Syntax description

Method Summary

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

COMMAND

public static final CommandLine.Type COMMAND

Full command description

METHOD

public static final CommandLine.Type METHOD

Method/function parameter description

SYNTAX

public static final CommandLine.Type SYNTAX

Syntax description

Method Details

values

public static CommandLine.Type[] 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 CommandLine.Type 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