jdk.dio

Interface DeviceDescriptor<P extends Device<? super P>>

Type Parameters:

P - the device type the descriptor is defined for.

public interface DeviceDescriptor<P extends Device<? super P>>

The DeviceDescriptor interface encapsulates the identifying and descriptive information of a device as well as its registered configuration (hardware addressing parameters, and static and dynamic configuration parameters).

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNDEFINED_ID Undefined device numeric ID.

Method Summary

Methods

Modifier and Type	Method and Description
<C extends DeviceConfig<? super P>> C	getConfiguration() Returns the actual configuration of the device.
int	getID() Returns the numeric ID of the device.
java.lang.Class<P>	getInterface() Returns the interface (sub-interface of Device) of the device.
java.lang.String	getName() Returns the name of the device.
java.lang.String[]	getProperties() Returns the properties of the device.

Field Detail

UNDEFINED_ID

static final int UNDEFINED_ID

Undefined device numeric ID.

See Also:

Constant Field Values

Method Detail

getID

int getID()

Returns the numeric ID of the device. If the device has been opened with an ad-hoc configuration such as by calling DeviceManager.open(java.lang.Class, jdk.dio.DeviceConfig) this device's numeric ID is undefined.

Returns:

the device's numeric ID (an integer number greater than or equal to 0) or UNDEFINED_ID if none is defined.

getName

java.lang.String getName()

Returns the name of the device. A name is a descriptive version of the device ID. For example, "LED1".

Returns:

the device's name (a free-form strings) or null if none is defined.

getProperties

java.lang.String[] getProperties()

Returns the properties of the device.

Returns:

a String array (a defensive copy) of the device properties or an empty String array if none are defined.

getInterface

java.lang.Class<P> getInterface()

Returns the interface (sub-interface of Device) of the device.

Returns:

the interface (sub-interface of Device) of the device.

getConfiguration

<C extends DeviceConfig<? super P>> C getConfiguration()

Returns the actual configuration of the device. The actual settings are returned; DeviceConfig.UNASSIGNED (or null) may still be returned for a hardware addressing, static or dynamic configuration parameter to indicate that it is unassigned (such as when it is not supported).

Type Parameters:

C - the device configuration type.

Returns:

the registered DeviceConfig which encapsulates the hardware addressing information, and static and dynamic configuration parameters of this device device; or null if none is defined.