org.cybergarage.upnp.AllowedValueRange Class Reference

Public Member Functions
Node	getAllowedValueRangeNode ()
	AllowedValueRange (Node node)
	AllowedValueRange ()
	AllowedValueRange (Number max, Number min, Number step)
void	setMinimum (String value)
String	getMinimum ()
void	setMaximum (String value)
String	getMaximum ()
void	setStep (String value)
String	getStep ()

Static Public Member Functions
static boolean	isAllowedValueRangeNode (Node node)

Static Public Attributes
static final String	ELEM_NAME = "allowedValueRange"

Private Attributes
Node	allowedValueRangeNode

Static Private Attributes
static final String	MINIMUM = "minimum"
static final String	MAXIMUM = "maximum"
static final String	STEP = "step"

Detailed Description

Represents an allowed value range for a UPnP state variable.

This class defines a numeric range constraint for state variables, including minimum, maximum, and optional step values. It is used when a state variable can take any numeric value within a specified range.

See also

StateVariable

AllowedValue

Constructor & Destructor Documentation

AllowedValueRange() [1/3]

org.cybergarage.upnp.AllowedValueRange.AllowedValueRange ( Node node )

inline

Constructs an allowed value range from an existing XML node.

Parameters

node	the XML node representing the allowed value range

AllowedValueRange() [2/3]

org.cybergarage.upnp.AllowedValueRange.AllowedValueRange ( )

inline

Constructs an empty allowed value range.

AllowedValueRange() [3/3]

org.cybergarage.upnp.AllowedValueRange.AllowedValueRange ( Number max, Number min, Number step )

inline

Constructs an allowed value range with specified bounds and step.

Parameters

max	the maximum allowed value, or null to omit
min	the minimum allowed value, or null to omit
step	the step increment, or null to omit

Member Function Documentation

getAllowedValueRangeNode()

Node org.cybergarage.upnp.AllowedValueRange.getAllowedValueRangeNode ( )

inline

Returns the underlying XML node representing this allowed value range.

Returns

the allowed value range XML node

getMaximum()

String org.cybergarage.upnp.AllowedValueRange.getMaximum ( )

inline

Returns the maximum allowed value.

Returns

the maximum value as a string

getMinimum()

String org.cybergarage.upnp.AllowedValueRange.getMinimum ( )

inline

Returns the minimum allowed value.

Returns

the minimum value as a string

getStep()

String org.cybergarage.upnp.AllowedValueRange.getStep ( )

inline

Returns the step increment for the range.

Returns

the step increment as a string

isAllowedValueRangeNode()

static boolean org.cybergarage.upnp.AllowedValueRange.isAllowedValueRangeNode ( Node node )

inlinestatic

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

Parameters

node	the XML node to check

Returns

true if the node's name matches the allowed value range element name,
false otherwise

setMaximum()

void org.cybergarage.upnp.AllowedValueRange.setMaximum ( String value )

inline

Sets the maximum allowed value.

Parameters

value

the maximum value as a string

setMinimum()

void org.cybergarage.upnp.AllowedValueRange.setMinimum ( String value )

inline

Sets the minimum allowed value.

Parameters

value

the minimum value as a string

setStep()

void org.cybergarage.upnp.AllowedValueRange.setStep ( String value )

inline

Sets the step increment for the range.

The step defines the granularity of allowed values within the range.

Parameters

value

the step increment as a string

Field Documentation

allowedValueRangeNode

Node org.cybergarage.upnp.AllowedValueRange.allowedValueRangeNode

private

ELEM_NAME

final String org.cybergarage.upnp.AllowedValueRange.ELEM_NAME = "allowedValueRange"

static

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

MAXIMUM

final String org.cybergarage.upnp.AllowedValueRange.MAXIMUM = "maximum"

staticprivate

MINIMUM

final String org.cybergarage.upnp.AllowedValueRange.MINIMUM = "minimum"

staticprivate

STEP

final String org.cybergarage.upnp.AllowedValueRange.STEP = "step"

staticprivate

---

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

• core/src/main/java/org/cybergarage/upnp/AllowedValueRange.java