cdev.dir
Interface DeviceClass

public interface DeviceClass

extends DirectoryItem

For device class data and references to DeviceProperty objects.

You can obtain lists of property names defined for the device class with getPropertyNames() and getPropertyNames(listName). You can obtain the DeviceProperty object itself with getDeviceProperty(propertyName)

A DeviceClass object is identified by its name which must be unique for the implementation.
An array of all deviceclass names can be obtained with DirectoryService#getDeviceClassNames().
A subset array of deviceclass names can be obtained with DirectoryService#getDeviceClassNames(query).

A DeviceClass object can be obtained with DirectoryService#getDeviceClass(className).

General documentation in DirectoryService .

See Also:

DeviceData, DeviceProperty, DeviceList

Method Summary

DeviceProperty	getDeviceProperty(java.lang.String propertyName) Gets DeviceProperty object, given the property name.
java.lang.String[]	getPropertyListNames() Gets array of all propertylist names for the deviceclass.
java.lang.String[]	getPropertyNames() Gets array of all property names for the deviceclass.
java.lang.String[]	getPropertyNames(java.lang.String listName) Gets a ordered subset of the property names of a class.

Methods inherited from interface cdev.dir.DirectoryItem

getDescription, getInfo, getInfoLines, getInfoWidth, getName, getServiceName, toString

Method Detail

getDeviceProperty

public DeviceProperty getDeviceProperty(java.lang.String propertyName)
                                 throws NoSuchDataException,
                                        BadConnectionException,
                                        TooManyValuesException

Gets DeviceProperty object, given the property name.

Parameters:

propertyName - the name of the property

Returns:

DeviceProperty object

Throws:

NoSuchDataException - -

BadConnectionException - -

TooManyValuesException - -

getPropertyListNames

public java.lang.String[] getPropertyListNames()
                                        throws NoSuchDataException,
                                               BadConnectionException

Gets array of all propertylist names for the deviceclass. Array is ordered by list name.

Returns:

array of propertylist names

Throws:

NoSuchDataException - -

BadConnectionException - -

getPropertyNames

public java.lang.String[] getPropertyNames()
                                    throws NoSuchDataException,
                                           BadConnectionException

Gets array of all property names for the deviceclass. Array is ordered by property name.

Returns:

array of property names

Throws:

NoSuchDataException - -

BadConnectionException - -

getPropertyNames

public java.lang.String[] getPropertyNames(java.lang.String listName)
                                    throws NoSuchDataException,
                                           BadConnectionException

Gets a ordered subset of the property names of a class.

Parameters:

listName - the name for the sublist of properties for the device class.

Returns:

array of property names

Throws:

NoSuchDataException - -

BadConnectionException - -