com.whizzosoftware.hobson.api.device.proxy

Class AbstractHobsonDeviceProxy

java.lang.Object

com.whizzosoftware.hobson.api.device.proxy.AbstractHobsonDeviceProxy

All Implemented Interfaces:

HobsonDeviceProxy

public abstract class AbstractHobsonDeviceProxy
extends java.lang.Object
implements HobsonDeviceProxy

Constructor Summary

Constructors

Constructor and Description
AbstractHobsonDeviceProxy(HobsonPlugin plugin, java.lang.String id, java.lang.String defaultName, DeviceType type) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addTag(java.lang.String tag)
protected DeviceProxyVariable	createDeviceVariable(java.lang.String name, VariableMask mask)
protected DeviceProxyVariable	createDeviceVariable(java.lang.String name, VariableMask mask, java.lang.Object value, java.lang.Long lastUpdate)
protected DeviceProxyVariable	createDeviceVariable(java.lang.String name, VariableMask mask, VariableMediaType mediaType)
protected DeviceProxyVariable	createDeviceVariable(java.lang.String name, VariableMask mask, VariableMediaType mediaType, java.lang.Object value, java.lang.Long lastUpdate)
PropertyContainerClass	getConfigurationClass()
protected java.lang.Object	getConfigurationProperty(java.lang.String name)
protected abstract TypedProperty[]	getConfigurationPropertyTypes() Returns an array of configuration properties the device supports.
DeviceContext	getContext()
java.lang.String	getDefaultName()
HobsonDeviceDescriptor	getDescriptor()
DeviceError	getError()
java.lang.Long	getLastCheckin()
java.lang.String	getName()
protected HobsonPlugin	getPlugin() Returns this device's plugin.
DeviceType	getType()
DeviceVariableState	getVariableState(java.lang.String name)
boolean	hasError()
boolean	hasVariable(java.lang.String name)
boolean	isStarted()
protected void	postEvent(HobsonEvent event)
protected void	publishActionProvider(ActionProvider actionProvider)
protected void	publishVariables(java.util.Collection<DeviceProxyVariable> vars)
protected void	publishVariables(DeviceProxyVariable... vars)
protected void	setConfigurationProperty(java.lang.String name, java.lang.Object value)
protected void	setError(DeviceError deviceError) Sets the error information for this device and puts the device into an error state.
void	setLastCheckin(java.lang.Long lastCheckin)
protected void	setVariableValue(java.lang.String name, java.lang.Object value, java.lang.Long updateTime)
protected void	setVariableValues(java.util.Map<java.lang.String,java.lang.Object> values)
void	start(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> config)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.whizzosoftware.hobson.api.device.proxy.HobsonDeviceProxy

getManufacturerName, getManufacturerVersion, getModelName, getPreferredVariableName, onDeviceConfigurationUpdate, onSetVariables, onShutdown, onStartup

Constructor Detail

AbstractHobsonDeviceProxy

public AbstractHobsonDeviceProxy(HobsonPlugin plugin,
                                 java.lang.String id,
                                 java.lang.String defaultName,
                                 DeviceType type)

Constructor.

Parameters:

plugin - the HobsonPlugin that created this device

id - the device ID

defaultName - the default name of the device (used when a user-defined name does not exist)

type - the type of device

Method Detail

getConfigurationClass

public PropertyContainerClass getConfigurationClass()

Specified by:

getConfigurationClass in interface HobsonDeviceProxy

getContext

public DeviceContext getContext()

Specified by:

getContext in interface HobsonDeviceProxy

getDefaultName

public java.lang.String getDefaultName()

Specified by:

getDefaultName in interface HobsonDeviceProxy

getDescriptor

public HobsonDeviceDescriptor getDescriptor()

Specified by:

getDescriptor in interface HobsonDeviceProxy

getError

public DeviceError getError()

Specified by:

getError in interface HobsonDeviceProxy

getLastCheckin

public java.lang.Long getLastCheckin()

Specified by:

getLastCheckin in interface HobsonDeviceProxy

getName

public java.lang.String getName()

Specified by:

getName in interface HobsonDeviceProxy

getType

public DeviceType getType()

Specified by:

getType in interface HobsonDeviceProxy

getVariableState

public DeviceVariableState getVariableState(java.lang.String name)

Specified by:

getVariableState in interface HobsonDeviceProxy

hasError

public boolean hasError()

Specified by:

hasError in interface HobsonDeviceProxy

hasVariable

public boolean hasVariable(java.lang.String name)

Specified by:

hasVariable in interface HobsonDeviceProxy

isStarted

public boolean isStarted()

Specified by:

isStarted in interface HobsonDeviceProxy

setLastCheckin

public void setLastCheckin(java.lang.Long lastCheckin)

Specified by:

setLastCheckin in interface HobsonDeviceProxy

start

public void start(java.lang.String name,
                  java.util.Map<java.lang.String,java.lang.Object> config)

Specified by:

start in interface HobsonDeviceProxy

addTag

protected void addTag(java.lang.String tag)

createDeviceVariable

protected DeviceProxyVariable createDeviceVariable(java.lang.String name,
                                                   VariableMask mask)

createDeviceVariable

protected DeviceProxyVariable createDeviceVariable(java.lang.String name,
                                                   VariableMask mask,
                                                   VariableMediaType mediaType)

createDeviceVariable

protected DeviceProxyVariable createDeviceVariable(java.lang.String name,
                                                   VariableMask mask,
                                                   VariableMediaType mediaType,
                                                   java.lang.Object value,
                                                   java.lang.Long lastUpdate)

createDeviceVariable

protected DeviceProxyVariable createDeviceVariable(java.lang.String name,
                                                   VariableMask mask,
                                                   java.lang.Object value,
                                                   java.lang.Long lastUpdate)

getConfigurationPropertyTypes

protected abstract TypedProperty[] getConfigurationPropertyTypes()

Returns an array of configuration properties the device supports. These will automatically be registered with the device's configuration class.

Returns:

an array of TypedProperty objects (or null if there are none)

getConfigurationProperty

protected java.lang.Object getConfigurationProperty(java.lang.String name)

getPlugin

protected HobsonPlugin getPlugin()

Returns this device's plugin.

Returns:

a HobsonPlugin instance

postEvent

protected void postEvent(HobsonEvent event)

publishActionProvider

protected void publishActionProvider(ActionProvider actionProvider)

publishVariables

protected void publishVariables(DeviceProxyVariable... vars)

publishVariables

protected void publishVariables(java.util.Collection<DeviceProxyVariable> vars)

setConfigurationProperty

protected void setConfigurationProperty(java.lang.String name,
                                        java.lang.Object value)

setError

protected void setError(DeviceError deviceError)

Sets the error information for this device and puts the device into an error state.

Parameters:

deviceError - the device error information

setVariableValue

protected void setVariableValue(java.lang.String name,
                                java.lang.Object value,
                                java.lang.Long updateTime)

setVariableValues

protected void setVariableValues(java.util.Map<java.lang.String,java.lang.Object> values)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object