Enum Key

java.lang.Object

java.lang.Enum<Key>

org.aesh.readline.terminal.Key

All Implemented Interfaces:

Serializable, Comparable<Key>, java.lang.constant.Constable, KeyAction

public enum Key
extends Enum<Key>
implements KeyAction

ANSCII enum key chart

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
a
A
AMPERSAND
APOSTROPHE
AT
b
B
BACKSLASH
BACKSPACE
c
C
COLON
COMMA
CTRL_A
CTRL_AT
CTRL_B
CTRL_C
CTRL_D
CTRL_DOWN
CTRL_E
CTRL_F
CTRL_G
CTRL_H
CTRL_I
CTRL_J
CTRL_K
CTRL_L
CTRL_LEFT
CTRL_M
CTRL_N
CTRL_O
CTRL_P
CTRL_Q
CTRL_R
CTRL_RIGHT
CTRL_S
CTRL_T
CTRL_U
CTRL_UP
CTRL_V
CTRL_W
CTRL_X
CTRL_X_CTRL_U
CTRL_Y
CTRL_Z
d
D
DELETE
DOLLAR
DOWN
DOWN_2
e
E
EIGHT
END
END_2
END_3
ENTER
ENTER_2
EQUALS
ESC
EXCLAMATION
f
F
FILE_SEPARATOR
FIVE
FOUR
g
G
GRAVE
GREATER_THAN
GROUP_SEPARATOR
h
H
HASH
HAT
HOME
HOME_2
HOME_3
i
I
INSERT
j
J
k
K
l
L
LEFT
LEFT_2
LEFT_CURLY_BRACKET
LEFT_PARANTHESIS
LEFT_SQUARE_BRACKET
LESS_THAN
m
M
META_a
META_b
META_BACKSPACE
META_c
META_CTRL_D
META_CTRL_J
META_d
META_e
META_f
META_l
META_u
MINUS
n
N
NINE
o
O
ONE
p
P
PERCENT
PERIOD
PGDOWN
PGDOWN_2
PGUP
PGUP_2
PLUS
q
Q
QUESTION_MARK
QUOTE
r
R
RECORD_SEPARATOR
RIGHT
RIGHT_2
RIGHT_CURLY_BRACKET
RIGHT_PARANTHESIS
RIGHT_SQUARE_BRACKET
s
S
SEMI_COLON
SEVEN
SIX
SLASH
SPACE
STAR
t
T
THREE
TILDE
TWO
u
U
UNDERSCORE
UNIT_SEPARATOR
UP
UP_2
v
V
VERTICAL_BAR
w
W
WINDOWS_ESC
WINDOWS_ESC_2
x
X
y
Y
z
Z
ZERO

Method Summary

Modifier and Type	Method	Description
IntBuffer	buffer()
boolean	containKey(int[] input)
boolean	equalTo(int[] otherValues)
boolean	equalTo(KeyAction key)
static Key	findStartKey(int[] input)
static Key	findStartKey(int[] input, int position)
char	getAsChar()
int	getCodePointAt(int index)
int	getFirstValue()
static Key	getKey(int[] otherValues)
int[]	getKeyValues()
String	getKeyValuesAsString()
boolean	inputStartsWithKey(int[] input)
boolean	inputStartsWithKey(int[] input, int position)
boolean	isCharacter()	is of type a-z or A-Z
boolean	isNumber()
boolean	isPrintable()
static boolean	isPrintable(int value)
static boolean	isPrintable(int[] keyValues)
static boolean	isPrintable(IntBuffer keyValues)
int	length()
static boolean	startsWithEscape(int[] input)
static Key	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Key[]	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

Methods inherited from interface KeyAction

bufferEquals, name

Enum Constant Details

CTRL_AT

public static final Key CTRL_AT

CTRL_A

public static final Key CTRL_A

CTRL_B

public static final Key CTRL_B

CTRL_C

public static final Key CTRL_C

CTRL_D

public static final Key CTRL_D

CTRL_E

public static final Key CTRL_E

CTRL_F

public static final Key CTRL_F

CTRL_G

public static final Key CTRL_G

CTRL_H

public static final Key CTRL_H

CTRL_I

public static final Key CTRL_I

CTRL_J

public static final Key CTRL_J

CTRL_K

public static final Key CTRL_K

CTRL_L

public static final Key CTRL_L

CTRL_M

public static final Key CTRL_M

CTRL_N

public static final Key CTRL_N

CTRL_O

public static final Key CTRL_O

CTRL_P

public static final Key CTRL_P

CTRL_Q

public static final Key CTRL_Q

CTRL_R

public static final Key CTRL_R

CTRL_S

public static final Key CTRL_S

CTRL_T

public static final Key CTRL_T

CTRL_U

public static final Key CTRL_U

CTRL_V

public static final Key CTRL_V

CTRL_W

public static final Key CTRL_W

CTRL_X

public static final Key CTRL_X

CTRL_Y

public static final Key CTRL_Y

CTRL_Z

public static final Key CTRL_Z

ESC

public static final Key ESC

FILE_SEPARATOR

public static final Key FILE_SEPARATOR

GROUP_SEPARATOR

public static final Key GROUP_SEPARATOR

RECORD_SEPARATOR

public static final Key RECORD_SEPARATOR

UNIT_SEPARATOR

public static final Key UNIT_SEPARATOR

SPACE

public static final Key SPACE

EXCLAMATION

public static final Key EXCLAMATION

QUOTE

public static final Key QUOTE

HASH

public static final Key HASH

DOLLAR

public static final Key DOLLAR

PERCENT

public static final Key PERCENT

AMPERSAND

public static final Key AMPERSAND

APOSTROPHE

public static final Key APOSTROPHE

LEFT_PARANTHESIS

public static final Key LEFT_PARANTHESIS

RIGHT_PARANTHESIS

public static final Key RIGHT_PARANTHESIS

STAR

public static final Key STAR

PLUS

public static final Key PLUS

COMMA

public static final Key COMMA

MINUS

public static final Key MINUS

PERIOD

public static final Key PERIOD

SLASH

public static final Key SLASH

ZERO

public static final Key ZERO

ONE

public static final Key ONE

TWO

public static final Key TWO

THREE

public static final Key THREE

FOUR

public static final Key FOUR

FIVE

public static final Key FIVE

SIX

public static final Key SIX

SEVEN

public static final Key SEVEN

EIGHT

public static final Key EIGHT

NINE

public static final Key NINE

COLON

public static final Key COLON

SEMI_COLON

public static final Key SEMI_COLON

LESS_THAN

public static final Key LESS_THAN

EQUALS

public static final Key EQUALS

GREATER_THAN

public static final Key GREATER_THAN

QUESTION_MARK

public static final Key QUESTION_MARK

AT

public static final Key AT

A

public static final Key A

B

public static final Key B

C

public static final Key C

D

public static final Key D

E

public static final Key E

F

public static final Key F

G

public static final Key G

H

public static final Key H

I

public static final Key I

J

public static final Key J

K

public static final Key K

L

public static final Key L

M

public static final Key M

N

public static final Key N

O

public static final Key O

P

public static final Key P

Q

public static final Key Q

R

public static final Key R

S

public static final Key S

T

public static final Key T

U

public static final Key U

V

public static final Key V

W

public static final Key W

X

public static final Key X

Y

public static final Key Y

Z

public static final Key Z

LEFT_SQUARE_BRACKET

public static final Key LEFT_SQUARE_BRACKET

BACKSLASH

public static final Key BACKSLASH

RIGHT_SQUARE_BRACKET

public static final Key RIGHT_SQUARE_BRACKET

HAT

public static final Key HAT

UNDERSCORE

public static final Key UNDERSCORE

GRAVE

public static final Key GRAVE

a

public static final Key a

b

public static final Key b

c

public static final Key c

d

public static final Key d

e

public static final Key e

f

public static final Key f

g

public static final Key g

h

public static final Key h

i

public static final Key i

j

public static final Key j

k

public static final Key k

l

public static final Key l

m

public static final Key m

n

public static final Key n

o

public static final Key o

p

public static final Key p

q

public static final Key q

r

public static final Key r

s

public static final Key s

t

public static final Key t

u

public static final Key u

v

public static final Key v

w

public static final Key w

x

public static final Key x

y

public static final Key y

z

public static final Key z

LEFT_CURLY_BRACKET

public static final Key LEFT_CURLY_BRACKET

VERTICAL_BAR

public static final Key VERTICAL_BAR

RIGHT_CURLY_BRACKET

public static final Key RIGHT_CURLY_BRACKET

TILDE

public static final Key TILDE

BACKSPACE

public static final Key BACKSPACE

WINDOWS_ESC

public static final Key WINDOWS_ESC

WINDOWS_ESC_2

public static final Key WINDOWS_ESC_2

UP

public static final Key UP

DOWN

public static final Key DOWN

RIGHT

public static final Key RIGHT

LEFT

public static final Key LEFT

UP_2

public static final Key UP_2

DOWN_2

public static final Key DOWN_2

RIGHT_2

public static final Key RIGHT_2

LEFT_2

public static final Key LEFT_2

META_a

public static final Key META_a

META_b

public static final Key META_b

META_c

public static final Key META_c

META_d

public static final Key META_d

META_e

public static final Key META_e

META_f

public static final Key META_f

META_l

public static final Key META_l

META_u

public static final Key META_u

META_BACKSPACE

public static final Key META_BACKSPACE

DELETE

public static final Key DELETE

INSERT

public static final Key INSERT

PGUP

public static final Key PGUP

PGUP_2

public static final Key PGUP_2

PGDOWN

public static final Key PGDOWN

PGDOWN_2

public static final Key PGDOWN_2

HOME

public static final Key HOME

HOME_2

public static final Key HOME_2

HOME_3

public static final Key HOME_3

END

public static final Key END

END_2

public static final Key END_2

END_3

public static final Key END_3

META_CTRL_J

public static final Key META_CTRL_J

META_CTRL_D

public static final Key META_CTRL_D

CTRL_X_CTRL_U

public static final Key CTRL_X_CTRL_U

CTRL_LEFT

public static final Key CTRL_LEFT

CTRL_RIGHT

public static final Key CTRL_RIGHT

CTRL_UP

public static final Key CTRL_UP

CTRL_DOWN

public static final Key CTRL_DOWN

ENTER

public static final Key ENTER

ENTER_2

public static final Key ENTER_2

Method Details

values

public static Key[] 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 Key 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

isCharacter

public boolean isCharacter()

is of type a-z or A-Z

isNumber

public boolean isNumber()

Returns:

true if input is 0-9

isPrintable

public boolean isPrintable()

Returns:

true if input is a valid char

isPrintable

public static boolean isPrintable(int value)

isPrintable

public static boolean isPrintable(int[] keyValues)

isPrintable

public static boolean isPrintable(IntBuffer keyValues)

getAsChar

public char getAsChar()

getKeyValues

public int[] getKeyValues()

getKeyValuesAsString

public String getKeyValuesAsString()

getFirstValue

public int getFirstValue()

startsWithEscape

public static boolean startsWithEscape(int[] input)

getKey

public static Key getKey(int[] otherValues)

findStartKey

public static Key findStartKey(int[] input)

findStartKey

public static Key findStartKey(int[] input,
 int position)

inputStartsWithKey

public boolean inputStartsWithKey(int[] input)

inputStartsWithKey

public boolean inputStartsWithKey(int[] input,
 int position)

containKey

public boolean containKey(int[] input)

equalTo

public boolean equalTo(int[] otherValues)

equalTo

public boolean equalTo(KeyAction key)

getCodePointAt

public int getCodePointAt(int index)

Specified by:

getCodePointAt in interface KeyAction

length

public int length()

Specified by:

length in interface KeyAction

buffer

public IntBuffer buffer()

Specified by:

buffer in interface KeyAction