ej.ecom

Interface Device

All Known Subinterfaces:

CommPort

public interface Device

Common superclass for a Device. When a Device implements Connectable interface, then the argument of Connectable.openConnection(String) correspond to the params part of Connector URL specification. A device is uniquely identified with its name and its hardware descriptor.

See Also:

Connector

Field Summary

Fields

Modifier and Type	Field and Description
static String	UNKNOWN_NAME This value is returned by getName() when this device is unregistered and its name is unavailable.

Method Summary

Modifier and Type	Method and Description
Device[]	getChildren() Returns the children of this device in the hardware topology.
<D extends Device> HardwareDescriptor<D>	getDescriptor() Returns the device hardware descriptor.
String	getName() Returns the name of the device.
Device	getParent() Returns the parent of this device in the hardware topology.

Field Detail

UNKNOWN_NAME

static final String UNKNOWN_NAME

This value is returned by getName() when this device is unregistered and its name is unavailable.

See Also:

Constant Field Values

Method Detail

getChildren

Device[] getChildren()

Returns the children of this device in the hardware topology.

Returns:

an empty array if it is a leaf device.

getDescriptor

<D extends Device> HardwareDescriptor<D> getDescriptor()

Returns the device hardware descriptor.

Type Parameters:

D - the type of the device

Returns:

the device hardware descriptor

getName

String getName()

Returns the name of the device.

Returns:

the device name, UNKNOWN_NAME if this device is not registered and its name is unavailable.

getParent

Device getParent()

Returns the parent of this device in the hardware topology.

Returns:

null if it is a root device.