org.openptk.api
Class Output

java.lang.Object
  org.openptk.api.Element
      org.openptk.api.Output

All Implemented Interfaces:

ElementIF

public class Output
extends Element

The Output object contains the State/Status and Results of an Operation.

Author:

Scott Fehrman, Sun Microsystems, Inc.

Constructor Summary

Output()
Creates a new Ouput object.

Output(Output output)
Creates a new Output that is a copy of the specified Output.

Method Summary

void	addResult(ElementIF result) Add a Result, (ElementIF object) to the Output.
Output	copy() Creates a "deep" copy of the Output.
java.util.List<ElementIF>	getResults() Get the List of Results A List of ElementIF objects will be returned.
int	getResultsSize() Get the size (number) of the results.

Methods inherited from class org.openptk.api.Element

addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttributes, getAttribute, getAttributeNames, getAttributes, getAttributesSize, getDescription, getKey, getProperties, getPropertiesSize, getProperty, getState, getStateAsString, getStatus, getUniqueId, getUniqueIdType, isError, removeAttribute, removeProperty, setAttributes, setDescription, setError, setKey, setProperties, setProperty, setState, setStatus, setUniqueId, setUniqueId, setUniqueId, setUniqueId, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Output

public Output()

Creates a new Ouput object.

Output

public Output(Output output)

Creates a new Output that is a copy of the specified Output.

Parameters:

output -

Method Detail

addResult

public final void addResult(ElementIF result)

Add a Result, (ElementIF object) to the Output.

Parameters:

result - a result object from an operation

copy

public Output copy()

Creates a "deep" copy of the Output.

Specified by:

copy in interface ElementIF

Overrides:

copy in class Element

Returns:

Output the new Output (a copy)

getResults

public final java.util.List<ElementIF> getResults()

Get the List of Results A List of ElementIF objects will be returned. Notice: the List and its Elements are a "copy" of the internal List/Elements.

Returns:

List the list of Elements

getResultsSize

public final int getResultsSize()

Get the size (number) of the results.

Returns:

int the number of results that are available