org.loom.servlet.params
Class ServletRequestParameters

java.lang.Object
  org.loom.servlet.params.ServletRequestParameters

public class ServletRequestParameters
extends java.lang.Object

Parameters as received by the request object. This class can only store one value per name. If more than one parameter is added with the same name, only the first one will be processed. To handle multiple values, use indexes (values[2].name) where needed to ensure uniqueness.

Constructor Summary

ServletRequestParameters()

Method Summary

void	addFileParameter(java.lang.String name, FileParameter file) Adds an uploaded file item to the list of parameters
void	addFileParameters(java.util.Map<java.lang.String,FileParameter> params) Adds all the provided params to this RequestParams instance
void	addStringParameter(java.lang.String paramName, java.lang.String value) Add a parameter value to the list of processed params
void	addStringParameters(java.util.Map<java.lang.String,java.lang.String> params) Adds all the provided params to this RequestParams instance
boolean	contains(java.lang.String paramName)
FileParameter	getFileParameter(java.lang.String name)
java.util.Set<java.lang.String>	getFileParameterNames()
java.util.Set<java.util.Map.Entry<java.lang.String,FileParameter>>	getFileParametersEntrySet()
java.lang.String	getStringParameter(java.lang.String name)
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>	getStringParametersEntrySet()
boolean	isAssigned(java.lang.String paramName) Return true if the provided parameter has already been assigned to a java counterpart (action attribute or event parameter)
void	restoreFromRedirect(LoomServletRequest request) restores all parameters from a previous request (after a redirect).
void	saveForRedirect(LoomServletRequest request) Save the string parameters in this object to the flash context, to be retored at the next request.
void	setAssigned(java.lang.String name) Set the provided parameter name as assigned
int	size()
java.util.Map<java.lang.String,java.lang.String>	toParameterMap()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletRequestParameters

public ServletRequestParameters()

Method Detail

addFileParameter

public void addFileParameter(java.lang.String name,
                             FileParameter file)

Adds an uploaded file item to the list of parameters

Parameters:

file -

addStringParameter

public void addStringParameter(java.lang.String paramName,
                               java.lang.String value)

Add a parameter value to the list of processed params

addStringParameters

public void addStringParameters(java.util.Map<java.lang.String,java.lang.String> params)

Adds all the provided params to this RequestParams instance

Parameters:

params - the Map of params to be added

addFileParameters

public void addFileParameters(java.util.Map<java.lang.String,FileParameter> params)

Adds all the provided params to this RequestParams instance

Parameters:

params - the Map of params to be added

getStringParametersEntrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> getStringParametersEntrySet()

getFileParametersEntrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,FileParameter>> getFileParametersEntrySet()

getStringParameter

public java.lang.String getStringParameter(java.lang.String name)

getFileParameter

public FileParameter getFileParameter(java.lang.String name)

contains

public boolean contains(java.lang.String paramName)

size

public int size()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

a list of request params in the form name=value

toParameterMap

public java.util.Map<java.lang.String,java.lang.String> toParameterMap()

Returns:

the string parameters received

getFileParameterNames

public java.util.Set<java.lang.String> getFileParameterNames()

setAssigned

public void setAssigned(java.lang.String name)

Set the provided parameter name as assigned

isAssigned

public boolean isAssigned(java.lang.String paramName)

Return true if the provided parameter has already been assigned to a java counterpart (action attribute or event parameter)

saveForRedirect

public void saveForRedirect(LoomServletRequest request)

Save the string parameters in this object to the flash context, to be retored at the next request.

restoreFromRedirect

public void restoreFromRedirect(LoomServletRequest request)

restores all parameters from a previous request (after a redirect). This method is intended to restore parameters after an unsuccessful event execution because of errors in the user input data.

Parameters:

request -