Enum SearchDirection

java.lang.Object

java.lang.Enum<SearchDirection>

org.aesh.readline.history.SearchDirection

All Implemented Interfaces:

Serializable, Comparable<SearchDirection>, java.lang.constant.Constable

public enum SearchDirection
extends Enum<SearchDirection>

Enumeration representing the direction when searching through command history.

Author:

Ståle W. Pedersen

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FORWARD	Search forward through history (from oldest to newest).
REVERSE	Search backward through history (from newest to oldest).

Method Summary

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

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REVERSE

public static final SearchDirection REVERSE

Search backward through history (from newest to oldest).

FORWARD

public static final SearchDirection FORWARD

Search forward through history (from oldest to newest).

Method Details

values

public static SearchDirection[] values()

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

Returns:

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

valueOf

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