Package org.jline.terminal

Enum Class KeyEvent.ModKey

java.lang.Object

java.lang.Enum<KeyEvent.ModKey>

org.jline.terminal.KeyEvent.ModKey

All Implemented Interfaces:

Serializable, Comparable<KeyEvent.ModKey>, Constable

Enclosing class:

KeyEvent

public static enum KeyEvent.ModKey
extends Enum<KeyEvent.ModKey>

Identifies individual modifier keys for standalone key events. Only reported by the Kitty Keyboard Protocol with ReportAllKeys.

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
LeftAlt
LeftControl
LeftHyper
LeftMeta
LeftShift
LeftSuper
RightAlt
RightControl
RightHyper
RightMeta
RightShift
RightSuper

Method Summary

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

LeftShift

public static final KeyEvent.ModKey LeftShift

LeftControl

public static final KeyEvent.ModKey LeftControl

LeftAlt

public static final KeyEvent.ModKey LeftAlt

LeftSuper

public static final KeyEvent.ModKey LeftSuper

LeftHyper

public static final KeyEvent.ModKey LeftHyper

LeftMeta

public static final KeyEvent.ModKey LeftMeta

RightShift

public static final KeyEvent.ModKey RightShift

RightControl

public static final KeyEvent.ModKey RightControl

RightAlt

public static final KeyEvent.ModKey RightAlt

RightSuper

public static final KeyEvent.ModKey RightSuper

RightHyper

public static final KeyEvent.ModKey RightHyper

RightMeta

public static final KeyEvent.ModKey RightMeta

Method Details

values

public static KeyEvent.ModKey[] 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 KeyEvent.ModKey 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