com.oracle.deviceaccess.modem

Class ModemSignalEvent

java.lang.Object

com.oracle.deviceaccess.PeripheralEvent

com.oracle.deviceaccess.modem.ModemSignalEvent

public class ModemSignalEvent
extends PeripheralEvent

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

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 com.oracle.deviceaccess.PeripheralEvent

count, lastTimeStamp, lastTimeStampMicros, peripheral, timeStamp, timeStampMicros

Constructor Summary

Constructors

Constructor and Description
ModemSignalEvent(Peripheral peripheral, int signalID, boolean signalState) Creates a new ModemSignalEvent with the specified value and time-stamped with the current time.
ModemSignalEvent(Peripheral peripheral, 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 com.oracle.deviceaccess.PeripheralEvent

getCount, getLastTimeStamp, getLastTimeStampMicros, getPeripheral, getTimeStamp, getTimeStampMicros

Methods inherited from class java.lang.Object

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(Peripheral peripheral,
                int signalID,
                boolean signalState)

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

Parameters:

peripheral - the source peripheral.

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 peripheral is null.

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

ModemSignalEvent

public ModemSignalEvent(Peripheral peripheral,
                int signalID,
                boolean signalState,
                long timeStamp,
                int timeStampMicros)

Creates a new ModemSignalEvent with the specified value and timestamp.

Parameters:

peripheral - the source peripheral.

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 peripheral is null.

java.lang.IllegalArgumentException - if signalID is not a valid signal ID or if timeStamp or timeStampMicros is negative.

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.