com.oracle.deviceaccess

Interface PeripheralDescriptor<P extends Peripheral<? super P>>

Type Parameters:

P - the peripheral type the descriptor is defined for.

public interface PeripheralDescriptor<P extends Peripheral<? super P>>

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNDEFINED_ID Undefined peripheral numerical ID.

Method Summary

Methods

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

Field Detail

UNDEFINED_ID

static final int UNDEFINED_ID

Undefined peripheral numerical ID.

See Also:

Constant Field Values

Method Detail

getID

int getID()

Returns the numerical ID of the peripheral device. If the peripheral has been opened with an ad-hoc configuration such as by calling PeripheralManager.open(java.lang.Class, com.oracle.deviceaccess.PeripheralConfig) this peripheral's numerical ID is undefined.

Returns:

the peripheral's numerical 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 peripheral device. A name is a descriptive version of the peripheral ID. For example, "LED1".

Returns:

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

getProperties

java.lang.String[] getProperties()

Returns the properties of the peripheral device.

Returns:

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

getInterface

java.lang.Class<P> getInterface()

Returns the interface (sub-interface of Peripheral) of the peripheral device.

Returns:

the interface (sub-interface of Peripheral) of the peripheral device.

getConfiguration

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

Returns the registered configuration of the peripheral device.

Type Parameters:

C - the peripheral configuration type.

Returns:

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