jdk.dio.uart

Class UARTEvent

java.lang.Object

jdk.dio.DeviceEvent<UART>

jdk.dio.uart.UARTEvent

public class UARTEvent
extends DeviceEvent<UART>

The UARTEvent class encapsulates events fired by devices that implement the UART interface.

Since:

1.0

See Also:

UART, UARTEventListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	BREAK_INTERRUPT Event ID indicating a break interrupt.
static int	FRAMING_ERROR Event ID indicating a framing error.
static int	INPUT_BUFFER_OVERRUN Event ID indicating that 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.
static int	PARITY_ERROR Event ID indicating a parity error.

Fields inherited from class jdk.dio.DeviceEvent

count, device, lastTimeStamp, lastTimeStampMicros, timeStamp, timeStampMicros

Constructor Summary

Constructors

Constructor and Description
UARTEvent(UART uart, int id) Creates a new UARTEvent with the specified value and time-stamped with the current time.
UARTEvent(UART uart, int id, long timeStamp, int timeStampMicros) Creates a new UARTEvent 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, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INPUT_BUFFER_OVERRUN

public static final int INPUT_BUFFER_OVERRUN

Event ID indicating that 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

BREAK_INTERRUPT

public static final int BREAK_INTERRUPT

Event ID indicating a break interrupt.

See Also:

Constant Field Values

PARITY_ERROR

public static final int PARITY_ERROR

Event ID indicating a parity error.

See Also:

Constant Field Values

FRAMING_ERROR

public static final int FRAMING_ERROR

Event ID indicating a framing error.

See Also:

Constant Field Values

Constructor Detail

UARTEvent

public UARTEvent(UART uart,
         int id)

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

Parameters:

uart - the source UART.

id - the event ID: INPUT_DATA_AVAILABLE, INPUT_BUFFER_OVERRUN, OUTPUT_BUFFER_EMPTY, BREAK_INTERRUPT, FRAMING_ERROR or PARITY_ERROR.

Throws:

java.lang.NullPointerException - if uart is null.

java.lang.IllegalArgumentException - if id is not a valid event ID.

UARTEvent

public UARTEvent(UART uart,
         int id,
         long timeStamp,
         int timeStampMicros)

Creates a new UARTEvent with the specified value and timestamp.

Parameters:

uart - the source UART.

id - the event ID: INPUT_DATA_AVAILABLE, INPUT_BUFFER_OVERRUN, OUTPUT_BUFFER_EMPTY, BREAK_INTERRUPT, FRAMING_ERROR or PARITY_ERROR.

timeStamp - the timestamp (in milliseconds).

timeStampMicros - the additional microseconds to the timestamp.

Throws:

java.lang.NullPointerException - if uart is null.

java.lang.IllegalArgumentException - if id is not a valid event ID or if timeStamp is negative or timeStampMicros is not in the range [0 - 999].

Method Detail

getID

public int getID()

Returns this event ID.

Returns:

this event ID: INPUT_DATA_AVAILABLE, INPUT_BUFFER_OVERRUN, OUTPUT_BUFFER_EMPTY, BREAK_INTERRUPT, FRAMING_ERROR or PARITY_ERROR.