Module com.pi4j.crowpi

Package com.pi4j.crowpi.components

Enum Class IrReceiverComponent.Key

java.lang.Object

java.lang.Enum<IrReceiverComponent.Key>

com.pi4j.crowpi.components.IrReceiverComponent.Key

All Implemented Interfaces:

Serializable, Comparable<IrReceiverComponent.Key>, Constable

Enclosing class:

IrReceiverComponent

public static enum IrReceiverComponent.Key
extends Enum<IrReceiverComponent.Key>

Enumeration which represents all known keycodes for the bundled CrowPi IR remote

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
CH
CH_MINUS
CH_PLUS
EIGHT
EQ
FIVE
FOUR
HUNDRED_PLUS
NEXT
NINE
ONE
PLAY_PAUSE
PREV
SEVEN
SIX
THREE
TWO
TWO_HUNDRED_PLUS
VOL_MINUS
VOL_PLUS
ZERO

Method Summary

Modifier and Type	Method	Description
static IrReceiverComponent.Key	fromCode(byte code)	Returns the first key which matches the passed key code or null if no match is found.
byte	getCode()	Returns the keycode of the key.
String	getDescription()	Returns the description of the key.
String	toString()
static IrReceiverComponent.Key	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IrReceiverComponent.Key[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CH_MINUS

public static final IrReceiverComponent.Key CH_MINUS

CH

public static final IrReceiverComponent.Key CH

CH_PLUS

public static final IrReceiverComponent.Key CH_PLUS

PREV

public static final IrReceiverComponent.Key PREV

NEXT

public static final IrReceiverComponent.Key NEXT

PLAY_PAUSE

public static final IrReceiverComponent.Key PLAY_PAUSE

VOL_MINUS

public static final IrReceiverComponent.Key VOL_MINUS

VOL_PLUS

public static final IrReceiverComponent.Key VOL_PLUS

EQ

public static final IrReceiverComponent.Key EQ

ZERO

public static final IrReceiverComponent.Key ZERO

HUNDRED_PLUS

public static final IrReceiverComponent.Key HUNDRED_PLUS

TWO_HUNDRED_PLUS

public static final IrReceiverComponent.Key TWO_HUNDRED_PLUS

ONE

public static final IrReceiverComponent.Key ONE

TWO

public static final IrReceiverComponent.Key TWO

THREE

public static final IrReceiverComponent.Key THREE

FOUR

public static final IrReceiverComponent.Key FOUR

FIVE

public static final IrReceiverComponent.Key FIVE

SIX

public static final IrReceiverComponent.Key SIX

SEVEN

public static final IrReceiverComponent.Key SEVEN

EIGHT

public static final IrReceiverComponent.Key EIGHT

NINE

public static final IrReceiverComponent.Key NINE

Method Details

values

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

fromCode

public static IrReceiverComponent.Key fromCode(byte code)

Returns the first key which matches the passed key code or null if no match is found.

Parameters:

code - Keycode as byte

Returns:

Matched key if found or null if not found

getCode

public byte getCode()

Returns the keycode of the key.

Returns:

Keycode as byte

getDescription

public String getDescription()

Returns the description of the key.

Returns:

Human-readable key description matching the labels on the remote

toString

public String toString()

Overrides:

toString in class Enum<IrReceiverComponent.Key>