jdk.dio.generic

Class GenericEvent

java.lang.Object

jdk.dio.DeviceEvent<GenericDevice>

jdk.dio.generic.GenericEvent

public class GenericEvent
extends DeviceEvent<GenericDevice>

The GenericEvent class encapsulates events fired by devices that implement the GenericDevice interface.

See Also:

GenericDevice, GenericEventListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	INPUT_BUFFER_OVERRUN Event ID indicating an input buffer overrun.
static int	INPUT_DATA_AVAILABLE Event ID indicating that input data is available for reading.
static int	OUTPUT_BUFFER_EMPTY Event ID indicating that the output buffer is empty and that additional data may be written.

Fields inherited from class jdk.dio.DeviceEvent

count, device, lastTimeStamp, lastTimeStampMicros, timeStamp, timeStampMicros

Constructor Summary

Constructors

Constructor and Description
GenericEvent(GenericDevice device, int id) Creates a new GenericEvent with the specified value and time-stamped with the current time.
GenericEvent(GenericDevice device, int id, long timeStamp, int timeStampMicros) Creates a new GenericEvent with the specified value and timestamp.

Method Summary

Methods

Modifier and Type	Method and Description
int	getID() Returns this event ID.

Methods inherited from class jdk.dio.DeviceEvent

getCount, getDevice, getLastTimeStamp, getLastTimeStampMicros, getTimeStamp, getTimeStampMicros

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INPUT_BUFFER_OVERRUN

public static final int INPUT_BUFFER_OVERRUN

Event ID indicating an input buffer overrun.

See Also:

Constant Field Values

INPUT_DATA_AVAILABLE

public static final int INPUT_DATA_AVAILABLE

Event ID indicating that input data is available for reading.

See Also:

Constant Field Values

OUTPUT_BUFFER_EMPTY

public static final int OUTPUT_BUFFER_EMPTY

Event ID indicating that the output buffer is empty and that additional data may be written.

See Also:

Constant Field Values

Constructor Detail

GenericEvent

public GenericEvent(GenericDevice device,
            int id)

Creates a new GenericEvent with the specified value and time-stamped with the current time.

Parameters:

device - the source device.

id - the event ID: INPUT_DATA_AVAILABLE, INPUT_BUFFER_OVERRUN, OUTPUT_BUFFER_EMPTY or other device-specific event ID.

Throws:

java.lang.NullPointerException - if device is null.

java.lang.IllegalArgumentException - if id is negative.

GenericEvent

public GenericEvent(GenericDevice device,
            int id,
            long timeStamp,
            int timeStampMicros)

Creates a new GenericEvent with the specified value and timestamp.

Parameters:

device - the source device.

id - the event ID: INPUT_DATA_AVAILABLE, INPUT_BUFFER_OVERRUN, OUTPUT_BUFFER_EMPTY or other device-specific event ID.

timeStamp - the timestamp (in milliseconds).

timeStampMicros - the additional microseconds to the timestamp.

Throws:

java.lang.NullPointerException - if device is null.

java.lang.IllegalArgumentException - if id is negative or if timeStamp or timeStampMicros is negative.

Method Detail

getID

public int getID()

Returns this event ID.

Returns:

this event ID: INPUT_DATA_AVAILABLE, INPUT_BUFFER_OVERRUN, OUTPUT_BUFFER_EMPTY or other device-specific event IDs.