com.nitido.nimbox.http
Class HttpNimletOutput

java.lang.Object
  com.nitido.nimbox.http.HttpNimletOutput

All Implemented Interfaces:

NimletOutput

public class HttpNimletOutput
extends java.lang.Object
implements NimletOutput

This class implements the NimletOutput interface.

Constructor Summary

HttpNimletOutput()
This method instantiates a new NimletOutput with an empty set of paramters.

HttpNimletOutput(java.util.HashMap outValues)
This method instantiates a new NimletOutput with its paramters initialized to the contents of the given HashMap.

Method Summary

void	addValueForKey(java.lang.String key, java.lang.Object value) This method add the given object to the given key.
java.util.Vector	getAllValuesForKey(java.lang.String key) This method returns all the objects that are associated to the given key.
java.lang.String[]	getKeys() This method return all the keys stored in this NimletOutput.
java.util.HashMap	getOutValues() This method returns the actual HashMap used to store the Nimlet output parameters.
java.lang.String	getSkinName() This method returns the skin name to be dispatched by the NimletContainer.
java.lang.Object	getValueForKey(java.lang.String key) This method returns the first object associated with the given key.
void	removeAllValuesForKey(java.lang.String key) This method removes all the objects that are associated with the given key.
void	removeValueForKey(java.lang.String key, java.lang.Object value) This method removes the given object from the given key.
void	replaceValueForKey(java.lang.String key, java.lang.Object value) This method replaces all existing values associated to the given key with the given object.
void	setSkinName(java.lang.String skinName) This method sets the skin name to be dispatched by the NimletContainer

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpNimletOutput

public HttpNimletOutput()

This method instantiates a new NimletOutput with an empty set of paramters.

HttpNimletOutput

public HttpNimletOutput(java.util.HashMap outValues)

This method instantiates a new NimletOutput with its paramters initialized to the contents of the given HashMap.

Parameters:

outValues - The set of name/value pairs to be included in this NimletOutput.

Method Detail

getOutValues

public java.util.HashMap getOutValues()

This method returns the actual HashMap used to store the Nimlet output parameters. This method is used by the driver as a mechanism to build a NimletInput in the event of Nimlet chaining, where the NimletOutput of one Nimlet becomes the NimletInput of another Nimlet.

Returns:

Reference to the underlying HashMap with all the Nimlet output parameters.

getValueForKey

public java.lang.Object getValueForKey(java.lang.String key)

Description copied from interface: NimletOutput

This method returns the first object associated with the given key.

Specified by:

getValueForKey in interface NimletOutput

Parameters:

key - The key of the requested object. This parameter cannot be null.

Returns:

The object that is associated to the given key. If the key has no values associated to it, this method returns null.

getAllValuesForKey

public java.util.Vector getAllValuesForKey(java.lang.String key)

Description copied from interface: NimletOutput

This method returns all the objects that are associated to the given key.

Specified by:

getAllValuesForKey in interface NimletOutput

Parameters:

key - The key of the requested object. This parameter cannot be null.

Returns:

A Vector of objects that are associated to the given key. If the key has no objects associated to it, this method returns an empty Vector.

getKeys

public java.lang.String[] getKeys()

Description copied from interface: NimletOutput

This method return all the keys stored in this NimletOutput.

Specified by:

getKeys in interface NimletOutput

Returns:

A String array with all the keys in this NimletOutput.

addValueForKey

public void addValueForKey(java.lang.String key,
                           java.lang.Object value)

Description copied from interface: NimletOutput

This method add the given object to the given key.

Specified by:

addValueForKey in interface NimletOutput

Parameters:

key - The key used to store the given object. This parameter cannot be null.

value - The object to be associated with the given key. This parameter cannot be null.

replaceValueForKey

public void replaceValueForKey(java.lang.String key,
                               java.lang.Object value)

Description copied from interface: NimletOutput

This method replaces all existing values associated to the given key with the given object.

Specified by:

replaceValueForKey in interface NimletOutput

Parameters:

key - The key used to store the given object. This parameter cannot be null.

value - The object to be associated with the given key. This parameter cannot be null.

removeValueForKey

public void removeValueForKey(java.lang.String key,
                              java.lang.Object value)

Description copied from interface: NimletOutput

This method removes the given object from the given key. If the key doesn't have the specified object, this method will ignore the request and return normally.

Specified by:

removeValueForKey in interface NimletOutput

Parameters:

key - The key under which the given object is stored. This parameter cannot be null.

value - The object to be removed from the input map. If this parameter is null, this method removes all the objects that are associated with the given key.

removeAllValuesForKey

public void removeAllValuesForKey(java.lang.String key)

Description copied from interface: NimletOutput

This method removes all the objects that are associated with the given key.

Specified by:

removeAllValuesForKey in interface NimletOutput

Parameters:

key - The key of all the objects to be removed from this NimletOutput. This parameter cannot be null.

getSkinName

public java.lang.String getSkinName()

Description copied from interface: NimletOutput

This method returns the skin name to be dispatched by the NimletContainer.

Specified by:

getSkinName in interface NimletOutput

Returns:

The NimletSkin to be dispatched by the NimletContainer. This method will return null if no skin name has been set.

setSkinName

public void setSkinName(java.lang.String skinName)

Description copied from interface: NimletOutput

This method sets the skin name to be dispatched by the NimletContainer

Specified by:

setSkinName in interface NimletOutput

Parameters:

skinName - The skin name to be dispatched by the NimletContainer.