Module org.cybergarage.upnp

Package org.cybergarage.upnp

Class ArgumentList

java.lang.Object

java.util.AbstractCollection

java.util.AbstractList

java.util.Vector

org.cybergarage.upnp.ArgumentList

All Implemented Interfaces:

Serializable, Cloneable, Iterable, Collection, List, RandomAccess, SequencedCollection

public class ArgumentList
extends Vector

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
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELEM_NAME	The XML element name for argument list nodes in SCPD documents.

Fields inherited from class java.util.Vector

capacityIncrement, elementCount, elementData

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
ArgumentList()	Constructs an empty argument list.

Method Summary

Modifier and Type	Method	Description
Argument	getArgument(int n)	Returns the argument at the specified index.
Argument	getArgument(String name)	Returns the argument with the specified name.
void	set(ArgumentList inArgList)	Deprecated. Use setReqArgs(ArgumentList) or setResArgs(ArgumentList) instead
void	setReqArgs(ArgumentList inArgList)	Sets values for all input arguments from the provided list.
void	setResArgs(ArgumentList outArgList)	Sets values for all output arguments from the provided list.

Methods inherited from class java.util.Vector

add, add, addAll, addAll, addElement, capacity, clear, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, forEach, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, iterator, lastElement, lastIndexOf, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeIf, removeRange, replaceAll, retainAll, set, setElementAt, setSize, size, sort, spliterator, subList, toArray, toArray, toString, trimToSize

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

addFirst, addLast, getFirst, getLast, removeFirst, removeLast, reversed

Field Details

ELEM_NAME

public static final String ELEM_NAME

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

See Also:

• Constant Field Values

Constructor Details

ArgumentList

public ArgumentList()

Constructs an empty argument list.

Method Details

getArgument

public Argument getArgument(int n)

Returns the argument at the specified index.

Parameters:

n - the index of the argument to retrieve

Returns:

the argument at the specified index

Throws:

ArrayIndexOutOfBoundsException - if the index is out of range

getArgument

public Argument getArgument(String name)

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

public void set(ArgumentList inArgList)

Deprecated.

Use setReqArgs(ArgumentList) or setResArgs(ArgumentList) instead

Sets argument values from the provided list.

Parameters:

inArgList - the argument list containing values to set

setReqArgs

public void setReqArgs(ArgumentList inArgList)

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

Throws:

IllegalArgumentException - if a required input argument is missing from the provided list

setResArgs

public void setResArgs(ArgumentList outArgList)

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

Throws:

IllegalArgumentException - if a required output argument is missing from the provided list