org.jagatoo.input.devices.components
Enum InputState

java.lang.Object
  java.lang.Enum<InputState>
      org.jagatoo.input.devices.components.InputState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<InputState>

public enum InputState
extends java.lang.Enum<InputState>

An input-state is a state, that is similar to a digital state. It additionally allows for volatile states, that only survive one frame.

Enum Constant Summary

MADE_NEGATIVE

MADE_POSITIVE

NEGATIVE

POSITIVE

Method Summary

boolean	getBooleanValue()
boolean	isVolatile()
static InputState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static InputState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

POSITIVE

public static final InputState POSITIVE

NEGATIVE

public static final InputState NEGATIVE

MADE_POSITIVE

public static final InputState MADE_POSITIVE

MADE_NEGATIVE

public static final InputState MADE_NEGATIVE

Method Detail

values

public static InputState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (InputState c : InputState.values())
    System.out.println(c);

Returns:

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

valueOf

public static InputState valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isVolatile

public final boolean isVolatile()

Returns:

if this state is volatile.
A volatile state is MADE_POSITIVE or MADE_NEGATIVE.

getBooleanValue

public final boolean getBooleanValue()

Returns:

a simple boolean value for this InputState.