com.nitido.nim
Interface NimletOutput

All Known Implementing Classes:

HttpNimletOutput

public interface NimletOutput

The NimletOutput is a data container of name/value pairs that represent the output of the request handling method of the Nimlet.

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.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

Method Detail

getValueForKey

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

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

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

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

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

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

java.lang.String[] getKeys()

This method return all the keys stored in this NimletOutput.

Returns:

A String array with all the keys in this NimletOutput.

addValueForKey

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

This method add the given object to the given key.

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

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.

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

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

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.

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

void removeAllValuesForKey(java.lang.String key)

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

Parameters:

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

getSkinName

java.lang.String getSkinName()

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

Returns:

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

setSkinName

void setSkinName(java.lang.String skinName)

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

Parameters:

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