me.legrange.panstamp

Interface DeviceLibrary

All Known Implementing Classes:

ClassLoaderLibrary, CompoundDeviceLibrary, FileLibrary, HttpLibrary

public interface DeviceLibrary

A device library can be implemented to find a device definition based on a panStamp's manufacturer ID and product ID. The device definitions are found in XML files, and while application developers will typically not implement this interface, it can be implemented to define custom ways of loading XML files.

Since:

1.0

Author:

Gideon le Grange https://github.com/GideonLeGrange

Method Summary

Modifier and Type	Method and Description
DeviceDefinition	getDeviceDefinition(int manufacturedID, int productId) get the device definition based on the supplied manufacturer ID and product ID.
boolean	hasDeviceDefinition(int manufacturedID, int productId) Checks if a device definition for the supplied manufacturer ID and product ID is available.

Method Detail

hasDeviceDefinition

boolean hasDeviceDefinition(int manufacturedID,
                            int productId)
                     throws NetworkException

Checks if a device definition for the supplied manufacturer ID and product ID is available.

Parameters:

manufacturedID - Manufacturer ID for device.

productId - Product ID for device.

Returns:

True if the definition is available.

Throws:

NetworkException - If there is a problem loading a device definition.

getDeviceDefinition

DeviceDefinition getDeviceDefinition(int manufacturedID,
                                     int productId)
                              throws NetworkException

get the device definition based on the supplied manufacturer ID and product ID.

Parameters:

manufacturedID - Manufacturer ID for device.

productId - Product ID for device.

Returns:

The device definition.

Throws:

NetworkException - If there is a problem loading a device definition.