jdk.dio.gpio

Class PinEvent

java.lang.Object

jdk.dio.DeviceEvent<GPIOPin>

jdk.dio.gpio.PinEvent

public class PinEvent
extends DeviceEvent<GPIOPin>

The PinEvent class encapsulates GPIO pin value changes. When/if value change events for the same GPIO pin are coalesced the value retained is that of the last occurrence.

Since:

1.0

See Also:

GPIOPin, PinListener

Field Summary

Fields inherited from class jdk.dio.DeviceEvent

count, device, lastTimeStamp, lastTimeStampMicros, timeStamp, timeStampMicros

Constructor Summary

Constructors

Constructor and Description
PinEvent(GPIOPin pin, boolean value) Creates a new PinEvent with the specified value and time-stamped with the current time.
PinEvent(GPIOPin pin, boolean value, long timeStamp, int timeStampMicros) Creates a new PinEvent with the specified value and timestamp.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getValue() Returns the new GPIO pin's value.

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

Constructor Detail

PinEvent

public PinEvent(GPIOPin pin,
        boolean value)

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

Parameters:

pin - the source GPIO pin.

value - the new value.

Throws:

java.lang.NullPointerException - if pin is null.

PinEvent

public PinEvent(GPIOPin pin,
        boolean value,
        long timeStamp,
        int timeStampMicros)

Creates a new PinEvent with the specified value and timestamp.

Parameters:

pin - the source GPIO pin.

value - the new value.

timeStamp - the timestamp (in milliseconds).

timeStampMicros - the additional microseconds to the timestamp.

Throws:

java.lang.NullPointerException - if pin is null.

java.lang.IllegalArgumentException - if timeStamp is negative or timeStampMicros is not in the range [0 - 999].

Method Detail

getValue

public boolean getValue()

Returns the new GPIO pin's value.

Returns:

the new GPIO pin's value.