com.sssw.jbroker.web.holders
Class ElementHolder

java.lang.Object
  com.sssw.jbroker.web.holders.ElementHolder

All Implemented Interfaces:

Holder, Holder

public class ElementHolder

extends Object

implements Holder

A holder class for an Element object that is used to store inout or out parameters in remote method calls. When calling a remote service that has an Element object as an inout or out parameter, the programmer must pass an instance of ElementHolder as the corresponding parameter in the method invocation. The input value must be set before invoking for inout paramters using the setValue method. Before the invocation returns, the runtime has filled in the value, which the programmer can access using the getResult method.

Field Summary

Element

value The return value held by this result object.

Constructor Summary

ElementHolder()
Default constructor for ElementHolder.

ElementHolder(Element value)
Construct a ElementHolder with the specified value.

Method Summary

Element	getResult() Get the result held within this ElementHolder.
void	read(InputStream is) Read the contents of this holder from an input stream.
void	setValue(Element value) Set the value held within this ElementHolder.
void	write(OutputStream os, String name) Write the contents of this holder to an output stream.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

value

public Element value

The return value held by this result object.

Constructor Detail

ElementHolder

public ElementHolder()

Default constructor for ElementHolder.

ElementHolder

public ElementHolder(Element value)

Construct a ElementHolder with the specified value. The value will be used as an input parameter when invoking the remote service.

Parameters:

value - The value held by this holder.

Method Detail

getResult

public Element getResult()

Get the result held within this ElementHolder. The value will be available after successfull invocation of the remote service.

Returns:

The return value.

setValue

public void setValue(Element value)

Set the value held within this ElementHolder. The value will be used as an input parameter when invoking the remote service.

Parameters:

value - The new value to be held by this holder.

read

public void read(InputStream is)
          throws IOException

Read the contents of this holder from an input stream.

Specified by:

read in interface Holder

Parameters:

is - The input stream.

Throws:

IOException - If an I/O error occurs.

write

public void write(OutputStream os,
                  String name)
           throws IOException

Write the contents of this holder to an output stream.

Specified by:

write in interface Holder

Parameters:

os - The output stream.

name - The parameter name.

Throws:

IOException - If an I/O error occurs.