net.tomp2p.upnp

Class Action

java.lang.Object

net.tomp2p.upnp.Action

public class Action
extends Object

An object to represent a service action proposed by an UPNP service

Version:

1.0

Author:

SuperBonBon

Field Summary

Fields

Modifier and Type	Field and Description
Argument[]	arguments
String	name
Service	parent

Method Summary

Methods

Modifier and Type	Method and Description
Argument	getActionArgument(String argumentName) Look for an Argument for a given name
Argument	getInputActionArgument(String argumentName) Look for an input ServiceActionArgument for a given name
Argument[]	getInputActionArguments() Return a list containing input ( when a response is sent ) arguments objects
String	getName() The action name
Argument	getOutputActionArgument(String argumentName) Look for an output Argument for a given name
Argument[]	getOutputActionArguments() Return a list containing output ( when a response is received ) arguments objects
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

public final String name

parent

public final Service parent

arguments

public final Argument[] arguments

Method Detail

getActionArgument

public Argument getActionArgument(String argumentName)

Look for an Argument for a given name

Parameters:

argumentName - the argument name

Returns:

the argument or null if not found or not available

getInputActionArguments

public Argument[] getInputActionArguments()

Return a list containing input ( when a response is sent ) arguments objects

Returns:

a list containing input arguments ServiceActionArgument objects or null when nothing is needed for such operation

getInputActionArgument

public Argument getInputActionArgument(String argumentName)

Look for an input ServiceActionArgument for a given name

Parameters:

argumentName - the input argument name

Returns:

the argument or null if not found or not available

getOutputActionArguments

public Argument[] getOutputActionArguments()

Return a list containing output ( when a response is received ) arguments objects

Returns:

a list containing output arguments ServiceActionArgument objects or null when nothing returned for such operation

getOutputActionArgument

public Argument getOutputActionArgument(String argumentName)

Look for an output Argument for a given name

Parameters:

argumentName - the input argument name

Returns:

the Argument or null if not found or not available

getName

public String getName()

The action name

Returns:

The action name

toString

public String toString()

Overrides:

toString in class Object