jdk.dio.modem

Class ModemSignalEvent<P extends Device<? super P>>

java.lang.Object

jdk.dio.DeviceEvent<P>

jdk.dio.modem.ModemSignalEvent<P>

Type Parameters:

P - the device type the event is defined for.

public class ModemSignalEvent<P extends Device<? super P>>
extends DeviceEvent<P>

The ModemSignalEvent class encapsulates modem signal state changes. When/if signal state change events for the same device are coalesced the value retained is that of the last occurrence.

Since:

1.0

See Also:

ModemSignalListener, ModemSignalsControl

Field Summary

Fields

Modifier and Type	Field and Description
protected int	signalID The signal ID.
protected boolean	signalState The signal state.

Fields inherited from class jdk.dio.DeviceEvent

count, device, lastTimeStamp, lastTimeStampMicros, timeStamp, timeStampMicros

Constructor Summary

Constructors

Constructor and Description
ModemSignalEvent(P device, int signalID, boolean signalState) Creates a new ModemSignalEvent with the specified value and time-stamped with the current time.
ModemSignalEvent(P device, int signalID, boolean signalState, long timeStamp, int timeStampMicros) Creates a new ModemSignalEvent with the specified value and timestamp.

Method Summary

Methods

Modifier and Type	Method and Description
int	getSignalID() Returns the signal ID.
boolean	getSignalState() Returns the new signal state.

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

signalID

protected int signalID

The signal ID.

signalState

protected boolean signalState

The signal state.

Constructor Detail

ModemSignalEvent

public ModemSignalEvent(P device,
                int signalID,
                boolean signalState)

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

Parameters:

device - the source device.

signalID - the ID of the signal that changed (ModemSignalsControl.DCD_SIGNAL, ModemSignalsControl.DSR_SIGNAL, ModemSignalsControl.RI_SIGNAL or ModemSignalsControl.CTS_SIGNAL).

signalState - the new signal state.

Throws:

java.lang.NullPointerException - if device is null.

java.lang.IllegalArgumentException - if signalID is not a valid signal ID.

ModemSignalEvent

public ModemSignalEvent(P device,
                int signalID,
                boolean signalState,
                long timeStamp,
                int timeStampMicros)

Creates a new ModemSignalEvent with the specified value and timestamp.

Parameters:

device - the source device.

signalID - the ID of the signal that changed (ModemSignalsControl.DCD_SIGNAL, ModemSignalsControl.DSR_SIGNAL, ModemSignalsControl.RI_SIGNAL or ModemSignalsControl.CTS_SIGNAL).

signalState - the new signal state.

timeStamp - the timestamp (in milliseconds).

timeStampMicros - the additional microseconds to the timestamp.

Throws:

java.lang.NullPointerException - if device is null.

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

Method Detail

getSignalID

public int getSignalID()

Returns the signal ID.

Returns:

the signal ID (ModemSignalsControl.DCD_SIGNAL, ModemSignalsControl.DSR_SIGNAL, ModemSignalsControl.RI_SIGNAL or ModemSignalsControl.CTS_SIGNAL).

getSignalState

public boolean getSignalState()

Returns the new signal state.

Returns:

the new signal state.