Package net.sbbi.upnp.services
Class StateVariable
- java.lang.Object
-
- net.sbbi.upnp.services.StateVariable
-
- All Implemented Interfaces:
StateVariableTypes
public class StateVariable extends java.lang.Object implements StateVariableTypes
Class to contain a service state variable definition
-
-
Field Summary
Fields Modifier and Type Field Description java.util.Set<java.lang.String>
allowedvalues
A set of allowed values (String objects) for the variablejava.lang.String
dataType
The variable UPNP data typejava.lang.String
defaultValue
The default value of the state variablejava.lang.String
maximumRangeValue
The maximum value as a stringjava.lang.String
minimumRangeValue
The minimum value as a stringjava.lang.String
name
State variable nameService
parent
The parentService
Objectboolean
sendEvents
Boolean to indicate if the variable is sending events when value of the var is changing.java.lang.String
stepRangeValue
The value step range as a string-
Fields inherited from interface net.sbbi.upnp.services.StateVariableTypes
BIN_BASE64, BIN_BASE64_INT, BIN_HEX, BIN_HEX_INT, BOOLEAN, BOOLEAN_INT, CHAR, CHAR_INT, DATE, DATE_INT, DATETIME, DATETIME_INT, DATETIME_TZ, DATETIME_TZ_INT, FIXED_14_4, FIXED_14_4_INT, FLOAT, FLOAT_INT, I1, I1_INT, I2, I2_INT, I4, I4_INT, INT, INT_INT, NUMBER, NUMBER_INT, R4, R4_INT, R8, R8_INT, STRING, STRING_INT, TIME, TIME_INT, TIME_TZ, TIME_TZ_INT, UI1, UI1_INT, UI2, UI2_INT, UI4, UI4_INT, URI, URI_INT, UUID, UUID_INT
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Class
getDataTypeAsClass()
The variable JAVA data type (using an UPNP->Java mapping)java.lang.String
getValue()
Call to the UPNP device to retrieve the state variable actual valuejava.lang.String
toString()
-
-
-
Field Detail
-
name
public final java.lang.String name
State variable name
-
sendEvents
public final boolean sendEvents
Boolean to indicate if the variable is sending events when value of the var is changing.
-
dataType
public final java.lang.String dataType
The variable UPNP data type
-
defaultValue
public final java.lang.String defaultValue
The default value of the state variable
-
minimumRangeValue
public final java.lang.String minimumRangeValue
The minimum value as a string
-
maximumRangeValue
public final java.lang.String maximumRangeValue
The maximum value as a string
-
stepRangeValue
public final java.lang.String stepRangeValue
The value step range as a string
-
allowedvalues
public final java.util.Set<java.lang.String> allowedvalues
A set of allowed values (String objects) for the variable
-
-
Method Detail
-
getValue
public java.lang.String getValue() throws UPNPResponseException, java.io.IOException
Call to the UPNP device to retrieve the state variable actual value- Returns:
- the state variable actual value on the device, should be never null, an empty string could be returned by the device
- Throws:
UPNPResponseException
- if the device throws an exception during queryjava.io.IOException
- if some IO error with device occurs during query
-
getDataTypeAsClass
public java.lang.Class getDataTypeAsClass()
The variable JAVA data type (using an UPNP->Java mapping)- Returns:
- the class mapped
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-