com.hp.device

Class AbstractDeviceDriverProvider

java.lang.Object

com.hp.device.AbstractDeviceDriverProvider

All Implemented Interfaces:

DeviceDriverProvider

Direct Known Subclasses:

DefaultDeviceDriverProvider

public abstract class AbstractDeviceDriverProvider
extends Object
implements DeviceDriverProvider

Base abstraction of a device driver provider for simplifying the task of implementing one.

Author:

Thomas Vachuska, Simon Hunt, Frank Wood

Constructor Summary

Constructors

Constructor and Description
AbstractDeviceDriverProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addType(DefaultDeviceType type) Convenience method that calls addType(String, DefaultDeviceType) using the type name returned from the type.
protected void	addType(String typeName, DefaultDeviceType type) Adds the specified device type to the type bindings under the given name.
DeviceHandler	create(DeviceInfo info, IpAddress ip) Creates an instance of DeviceHandler, bound to the specified device target, and associated with the specified instance of DeviceInfo.
DeviceLoader	create(DeviceInfo info, String uid) Creates an instance of DeviceLoader, bound to the specified device UID, and associated with the specified instance of DeviceInfo.
DeviceInfo	create(String typeName) Creates an instance of DeviceInfo backed by the specified device type and void of any specific device information.
DeviceHandler	create(String typeName, IpAddress ip) Creates an instance of DeviceHandler, bound to the specified device target, and associated with a new instance of DeviceInfo backed by the specified device type and void of any specific device information.
DeviceLoader	create(String typeName, String uid) Creates an instance of DeviceLoader, bound to the specified device UID, and associated with a new instance of DeviceInfo backed by the specified device type.
int	getBindingsCount() Returns the number of entries in the type bindings map
protected DefaultDeviceType	getDeviceType(String typeName) Gets the device type for the specified name, or null if no such binding exists.
Set<String>	getDeviceTypeNames() Returns a set of device type names for which this provider can create instances of DeviceInfo, DeviceHandler and DeviceLoader.
int	getTypesCount() Returns the number of different types in the bindings map
protected void	removeType(DefaultDeviceType type) Removes the specified device type and all its name bindings.
void	switchType(MutableDeviceInfo mutableDeviceInfo, String newTypeName) Given a device info instance and a type name, replace the backing device type in that instance, with the named device type.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractDeviceDriverProvider

public AbstractDeviceDriverProvider()

Method Detail

getDeviceTypeNames

public Set<String> getDeviceTypeNames()

Description copied from interface: DeviceDriverProvider

Returns a set of device type names for which this provider can create instances of DeviceInfo, DeviceHandler and DeviceLoader.

Specified by:

getDeviceTypeNames in interface DeviceDriverProvider

Returns:

array of device type names

addType

protected void addType(String typeName,
           DefaultDeviceType type)

Adds the specified device type to the type bindings under the given name.

Parameters:

typeName - device type name or alias (binding key)

type - device type instance

Throws:

IllegalArgumentException - if the provider declared by the type is not this provider

IllegalStateException - if a binding already exists for the given type name

addType

protected void addType(DefaultDeviceType type)

Convenience method that calls addType(String, DefaultDeviceType) using the type name returned from the type.

Parameters:

type - device type instance to add

removeType

protected void removeType(DefaultDeviceType type)

Removes the specified device type and all its name bindings. In addition, all descendants of the type will be removed from the provider also!

Parameters:

type - device type instance to remove

Throws:

IllegalStateException - if attempting to remove a type for which there is no binding

getDeviceType

protected DefaultDeviceType getDeviceType(String typeName)

Gets the device type for the specified name, or null if no such binding exists.

Parameters:

typeName - requested device type name

Returns:

device type of the given name, or null

getBindingsCount

public int getBindingsCount()

Returns the number of entries in the type bindings map

Returns:

the number of bindings

getTypesCount

public int getTypesCount()

Returns the number of different types in the bindings map

Returns:

the number of types

toString

public String toString()

Overrides:

toString in class Object

create

public DeviceInfo create(String typeName)

Description copied from interface: DeviceDriverProvider

Creates an instance of DeviceInfo backed by the specified device type and void of any specific device information. Returns null if there is no such mapping for the specified device type.

Specified by:

create in interface DeviceDriverProvider

Parameters:

typeName - the name of the required device type

Returns:

a new device info instance; or null

create

public DeviceHandler create(String typeName,
                   IpAddress ip)

Description copied from interface: DeviceDriverProvider

Creates an instance of DeviceHandler, bound to the specified device target, and associated with a new instance of DeviceInfo backed by the specified device type and void of any specific device information. Returns null if there is no such mapping for the specified device type.

Specified by:

create in interface DeviceDriverProvider

Parameters:

typeName - the name of the required device type

ip - the device IP address

Returns:

an available device handler instance; or null

create

public DeviceHandler create(DeviceInfo info,
                   IpAddress ip)

Description copied from interface: DeviceDriverProvider

Creates an instance of DeviceHandler, bound to the specified device target, and associated with the specified instance of DeviceInfo. Returns null if there is no such mapping for the specified device type.

Specified by:

create in interface DeviceDriverProvider

Parameters:

info - the device info instance

ip - the device IP address

Returns:

an available device handler instance; or null

create

public DeviceLoader create(String typeName,
                  String uid)

Description copied from interface: DeviceDriverProvider

Creates an instance of DeviceLoader, bound to the specified device UID, and associated with a new instance of DeviceInfo backed by the specified device type. Returns null if there is no such mapping for the specified device type.

Specified by:

create in interface DeviceDriverProvider

Parameters:

typeName - the name of the required device type

uid - the key by which the set of information describing the device can be looked up in the persistence store

Returns:

an available device loader instance; or null

create

public DeviceLoader create(DeviceInfo info,
                  String uid)

Description copied from interface: DeviceDriverProvider

Creates an instance of DeviceLoader, bound to the specified device UID, and associated with the specified instance of DeviceInfo. Returns null if there is no such mapping for the specified device type.

Specified by:

create in interface DeviceDriverProvider

Parameters:

info - the device info instance

uid - the key by which the set of information describing the device can be looked up in the persistence store

Returns:

an available device loader instance; or null

switchType

public void switchType(MutableDeviceInfo mutableDeviceInfo,
              String newTypeName)

Given a device info instance and a type name, replace the backing device type in that instance, with the named device type.

This implementation checks that the given type name exists in the type bindings, and switches the type if it does. If the type is not bound, then an exception is thrown.

Specified by:

switchType in interface DeviceDriverProvider

Parameters:

mutableDeviceInfo - the device info to be adjusted

newTypeName - the name of the replacement device type

Throws:

IllegalStateException - if the specified type is not bound in this provider