org.ogema.drivers.homematic.xmlrpc.ll.api

Interface ParameterDescription<T>

Type Parameters:

T - data type of the described parameter.

All Superinterfaces:

XmlRpcStruct

All Known Implementing Classes:

ParameterDescriptionXmlRpc

public interface ParameterDescription<T>
extends XmlRpcStruct

Represents a ParameterDescription as defined in the HomeMatic XML-RPC specification. Paramsets are respresented as Map<String, ParameterDescription>.

Author:

jlapp

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ParameterDescription.KEYS Keys used by the ParameterDescription XML-RPC struct.
static class	ParameterDescription.SET_TYPES Paramset types for HomeMatic XML-RPC.
static class	ParameterDescription.SPECIAL_KEYS Keys used by the XML-RPC structs in a ParameterDescription's ParameterDescription.KEYS.SPECIAL member.
static class	ParameterDescription.TYPES Parameter types used by HomeMatic XML-RPC.

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<ParameterDescription<?>>	TAB_ORDER_COMPARATOR

Method Summary

Modifier and Type	Method and Description
T	getDefault()
int	getOperations()
Map<String,T>	getSpecial()
int	getTabOrder()
ParameterDescription.TYPES	getType()
String	getUnit()
boolean	isEvent()
boolean	isReadable()
boolean	isWritable()

Methods inherited from interface org.ogema.drivers.homematic.xmlrpc.ll.api.XmlRpcStruct

containsKey, getBoolean, getInt, getString, getStringArray, getValue, keySet, setBoolean, setInt, setString, setStringArray, setValue, toMap

Field Detail

TAB_ORDER_COMPARATOR

static final Comparator<ParameterDescription<?>> TAB_ORDER_COMPARATOR

Method Detail

getType

ParameterDescription.TYPES getType()

getTabOrder

int getTabOrder()

getDefault

T getDefault()

getSpecial

Map<String,T> getSpecial()

getOperations

int getOperations()

isReadable

boolean isReadable()

isWritable

boolean isWritable()

isEvent

boolean isEvent()

getUnit

String getUnit()