com.digi.android.serial

Enum EventType

java.lang.Object

java.lang.Enum<EventType>

com.digi.android.serial.EventType

All Implemented Interfaces:

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

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

Enumerates the possible event types of the serial port.

See Also:

SerialPortEvent

Enum Constant Summary

Enum Constants

Enum Constant and Description
BI Break interrupt event type.
CD Carrier Detect event type.
CTS CTS event type.
DATA_AVAILABLE Data available to be read event type.
DSR DSR event type.
FE Framing error event type.
OE Overrun error event type.
OUTPUT_BUFFER_EMPTY Output buffer empty event type.
PE Parity error event type.
RI Ring Indicator event type.

Method Summary

Modifier and Type	Method and Description
static EventType	getById(int id) Returns the EventType associated to the provided ID.
int	getId() Returns the event ID.
static EventType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EventType[]	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, getSharedConstants, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DATA_AVAILABLE

public static final EventType DATA_AVAILABLE

Data available to be read event type.

OUTPUT_BUFFER_EMPTY

public static final EventType OUTPUT_BUFFER_EMPTY

Output buffer empty event type.

CTS

public static final EventType CTS

CTS event type.

DSR

public static final EventType DSR

DSR event type.

RI

public static final EventType RI

Ring Indicator event type.

CD

public static final EventType CD

Carrier Detect event type.

OE

public static final EventType OE

Overrun error event type.

PE

public static final EventType PE

Parity error event type.

FE

public static final EventType FE

Framing error event type.

BI

public static final EventType BI

Break interrupt event type.

Method Detail

values

public static EventType[] 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 (EventType c : EventType.values())
    System.out.println(c);

Returns:

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

valueOf

public static EventType 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

getId

public int getId()

Returns the event ID.

Returns:

The event ID.

getById

public static EventType getById(int id)

Returns the EventType associated to the provided ID.

Parameters:

id - The ID of the EventType to retrieve.

Returns:

The EventType associated to the provided ID.