org.cybergarage.upnp.ArgumentList Class Reference

Inheritance diagram for org.cybergarage.upnp.ArgumentList:

Public Member Functions
	ArgumentList ()
Argument	getArgument (int n)
Argument	getArgument (String name)
void	set (ArgumentList inArgList)
void	setReqArgs (ArgumentList inArgList)
void	setResArgs (ArgumentList outArgList)

Static Public Attributes
static final String	ELEM_NAME = "argumentList"

Detailed Description

A list of Argument objects.

This class extends Vector to provide type-safe access to UPnP action arguments. It includes methods for retrieving arguments by name or index, and for setting input/output argument values.

See also

Argument

Action

Constructor & Destructor Documentation

ArgumentList()

org.cybergarage.upnp.ArgumentList.ArgumentList ( )

inline

Constructs an empty argument list.

Member Function Documentation

getArgument() [1/2]

Argument org.cybergarage.upnp.ArgumentList.getArgument ( int n )

inline

Returns the argument at the specified index.

Parameters

n	the index of the argument to retrieve

Returns

the argument at the specified index

Exceptions

ArrayIndexOutOfBoundsException

if the index is out of range

getArgument() [2/2]

Argument org.cybergarage.upnp.ArgumentList.getArgument ( String name )

inline

Returns the argument with the specified name.

Parameters

name	the name of the argument to retrieve

Returns

the argument with the specified name, or null if not found

set()

void org.cybergarage.upnp.ArgumentList.set ( ArgumentList inArgList )

inline

Sets argument values from the provided list.

Parameters

inArgList

the argument list containing values to set

Deprecated

Use setReqArgs(ArgumentList) or setResArgs(ArgumentList) instead

setReqArgs()

void org.cybergarage.upnp.ArgumentList.setReqArgs ( ArgumentList inArgList )

inline

Sets values for all input arguments from the provided list.

Updates only arguments with direction "in" by matching names from the provided argument list.

Parameters

inArgList

the argument list containing input values

Exceptions

IllegalArgumentException

if a required input argument is missing from the provided list

setResArgs()

void org.cybergarage.upnp.ArgumentList.setResArgs ( ArgumentList outArgList )

inline

Sets values for all output arguments from the provided list.

Updates only arguments with direction "out" by matching names from the provided argument list.

Parameters

outArgList

the argument list containing output values

Exceptions

IllegalArgumentException

if a required output argument is missing from the provided list

Field Documentation

ELEM_NAME

final String org.cybergarage.upnp.ArgumentList.ELEM_NAME = "argumentList"

static

The XML element name for argument list nodes in SCPD documents.

---

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

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