Package com.diozero.internal.spi

Class AbstractDevice

java.lang.Object

com.diozero.internal.spi.AbstractDevice

All Implemented Interfaces:

DeviceInterface, InternalDeviceInterface, AutoCloseable

Direct Known Subclasses:

AbstractInputDevice, DefaultNativeSerialDevice, DefaultNativeSpiDevice, MCP23xxxDigitalOutputDevice, NativeGpioOutputDevice, NativeI2CDeviceJavaRaf, NativeI2CDeviceSMBus, OdroidC2SysFsPwmOutputDevice, PiconZero.PiconZeroAnalogOutputDevice, PiconZero.PiconZeroDigitalInputDevice, PiconZero.PiconZeroDigitalOutputDevice, PiconZero.PiconZeroPwmOutputDevice, PiconZero.PiconZeroServoDevice, PwmServoDevice, SoftwarePwmOutputDevice, SysFsDigitalOutputDevice, SysFsPwmOutputDevice

public abstract class AbstractDevice
extends Object
implements InternalDeviceInterface

Constructor Summary

Constructors

Constructor	Description
AbstractDevice(String key, DeviceFactoryInterface deviceFactory)

Method Summary

Modifier and Type	Method	Description
void	close()	Close this device
protected abstract void	closeDevice()
protected DeviceFactoryInterface	getDeviceFactory()
String	getKey()	Get the unique device identifier for this device
boolean	isChild()	Check if this is a child / wrapped device.
boolean	isOpen()	Check if this device is open or closed
void	setChild(boolean child)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractDevice

public AbstractDevice(String key,
                      DeviceFactoryInterface deviceFactory)

Method Detail

getKey

public final String getKey()

Description copied from interface: InternalDeviceInterface

Get the unique device identifier for this device

Specified by:

getKey in interface InternalDeviceInterface

Returns:

unique device identifier

isOpen

public boolean isOpen()

Description copied from interface: InternalDeviceInterface

Check if this device is open or closed

Specified by:

isOpen in interface InternalDeviceInterface

Returns:

true if this device is open

isChild

public boolean isChild()

Description copied from interface: InternalDeviceInterface

Check if this is a child / wrapped device. Child devices are assumed to be closed by the parent device. Key example is a software PWM output device that uses a digital output device.

Specified by:

isChild in interface InternalDeviceInterface

Returns:

true if this a child / wrapped device

setChild

public void setChild(boolean child)

Specified by:

setChild in interface InternalDeviceInterface

close

public final void close()

Description copied from interface: DeviceInterface

Close this device

Specified by:

close in interface AutoCloseable

Specified by:

close in interface DeviceInterface

getDeviceFactory

protected DeviceFactoryInterface getDeviceFactory()

closeDevice

protected abstract void closeDevice()
                             throws RuntimeIOException

Throws:

RuntimeIOException