cybergarage-upnp
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes
org.cybergarage.upnp.AllowedValue Class Reference

Public Member Functions

Node getAllowedValueNode ()
 
 AllowedValue (Node node)
 
 AllowedValue (String value)
 
void setValue (String value)
 
String getValue ()
 

Static Public Member Functions

static boolean isAllowedValueNode (Node node)
 

Static Public Attributes

static final String ELEM_NAME = "allowedValue"
 

Private Attributes

Node allowedValueNode
 

Detailed Description

Represents a single allowed value for a UPnP state variable.

State variables can define a list of allowed values that constrain the possible values the variable can take. This class represents one such allowed value as defined in the service's SCPD document.

See also
AllowedValueList
StateVariable

Constructor & Destructor Documentation

◆ AllowedValue() [1/2]

org.cybergarage.upnp.AllowedValue.AllowedValue ( Node node)
inline

Constructs an allowed value from an existing XML node.

Parameters
nodethe XML node representing the allowed value

◆ AllowedValue() [2/2]

org.cybergarage.upnp.AllowedValue.AllowedValue ( String value)
inline

Constructs an allowed value with the specified value string.

Creates a new XML node structure for the allowed value.

Parameters
valuethe value string to associate with this object
Author
Stefano "Kismet" Lenzi - kisme.nosp@m.t-sl.nosp@m.@user.nosp@m.s.so.nosp@m.urcef.nosp@m.orge.nosp@m..net - 2005

Member Function Documentation

◆ getAllowedValueNode()

Node org.cybergarage.upnp.AllowedValue.getAllowedValueNode ( )
inline

Returns the underlying XML node representing this allowed value.

Returns
the allowed value XML node

◆ getValue()

String org.cybergarage.upnp.AllowedValue.getValue ( )
inline

Returns the value string of this allowed value.

Returns
the value string

◆ isAllowedValueNode()

static boolean org.cybergarage.upnp.AllowedValue.isAllowedValueNode ( Node node)
inlinestatic

Checks if the given XML node represents an allowed value element.

Parameters
nodethe XML node to check
Returns
true if the node's name matches the allowed value element name, false otherwise

◆ setValue()

void org.cybergarage.upnp.AllowedValue.setValue ( String value)
inline

Sets the value string for this allowed value.

Parameters
valuethe value to set

Field Documentation

◆ allowedValueNode

Node org.cybergarage.upnp.AllowedValue.allowedValueNode
private

◆ ELEM_NAME

final String org.cybergarage.upnp.AllowedValue.ELEM_NAME = "allowedValue"
static

The XML element name for allowed value nodes in SCPD documents.

The documentation for this class was generated from the following file: