org.cybergarage.upnp.AllowedValueList Class Reference

Inheritance diagram for org.cybergarage.upnp.AllowedValueList:

Public Member Functions
	AllowedValueList ()
	AllowedValueList (String[] values)
AllowedValue	getAllowedValue (int n)
boolean	isAllowed (String v)

Static Public Attributes
static final String	ELEM_NAME = "allowedValueList"

Detailed Description

A list of AllowedValue objects for a state variable.

This class represents the set of allowed values that constrain a UPnP state variable. It extends Vector to provide type-safe access to allowed values and includes validation methods.

See also

AllowedValue

StateVariable

Constructor & Destructor Documentation

AllowedValueList() [1/2]

org.cybergarage.upnp.AllowedValueList.AllowedValueList ( )

inline

Constructs an empty allowed value list.

AllowedValueList() [2/2]

org.cybergarage.upnp.AllowedValueList.AllowedValueList ( String[] values )

inline

Constructs an allowed value list from an array of strings.

Parameters

values

the array of allowed value strings

Member Function Documentation

getAllowedValue()

AllowedValue org.cybergarage.upnp.AllowedValueList.getAllowedValue ( int n )

inline

Returns the allowed value at the specified index.

Parameters

n	the index of the allowed value to retrieve

Returns

the allowed value at the specified index

Exceptions

ArrayIndexOutOfBoundsException

if the index is out of range

isAllowed()

boolean org.cybergarage.upnp.AllowedValueList.isAllowed ( String v )

inline

Checks if the specified value is in the allowed value list.

Parameters

v	the value string to check

Returns

true if the value is allowed, false otherwise

Field Documentation

ELEM_NAME

final String org.cybergarage.upnp.AllowedValueList.ELEM_NAME = "allowedValueList"

static

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

---

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

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