Package name.matthewgreet.strutscommons.util

Class ParsedParameter

java.lang.Object

name.matthewgreet.strutscommons.util.ParsedParameter

All Implemented Interfaces:

Serializable

public class ParsedParameter
extends Object
implements Serializable

Value Object describing a HTTP parameter with field name and any index parsed from the parameter name, and placed into a parent FieldParsedParameterList list. For example, parameter name 'sponsor[2]' is indexed, has field name 'sponsor', and index 2.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ParsedParameter()

Method Summary

Modifier and Type	Method	Description
boolean	getFake()	Returns whether this is a fake placeholder, not a parameter submitted by the user.
String	getFieldName()	Returns field name extracted from parameter name.
boolean	getFile()	Returns whether this is a file parameter created by FileUploadInterceptor.
boolean	getHasIndex()	Returns whether an index was extracted and parsed from the parameter name.
int	getIndex()	Returns index within parent FieldParsedParameterList list, which will be the index extracted from parameter name, if found.
String	getParameterName()	Returns original parameter name.
String	getParameterValue()	Returns parameter value, which will be empty string for fake, non-file placeholders, or null file parameters.
UploadedFile	getUploadedFile()	Returns file data created FileUploadInterceptor.
static ParsedParameter	makeFakeIndexedFileParameter(String fieldName, int index)
static ParsedParameter	makeFakeIndexedParameter(String fieldName, int index, String parameterValue)
static ParsedParameter	makeFakeNonIndexedFileParameter(String fieldName)
static ParsedParameter	makeFakeNonIndexedParameter(String fieldName, String parameterValue)
static ParsedParameter	makeIndexedFileParameter(String fieldName, int index, UploadedFile uploadedFile)
static ParsedParameter	makeIndexedParameter(String fieldName, int index, String parameterValue)
static ParsedParameter	makeNonIndexedFileParameter(String fieldName, UploadedFile uploadedFile)
static ParsedParameter	makeNonIndexedParameter(String fieldName, String parameterValue)
void	setFake(boolean fake)
void	setFieldName(String fieldName)
void	setFile(boolean file)
void	setHasIndex(boolean hasIndex)
void	setIndex(int index)
void	setParameterName(String parameterName)
void	setParameterValue(String parameterValue)
void	setUploadedFile(UploadedFile uploadedFile)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ParsedParameter

public ParsedParameter()

Method Details

makeFakeIndexedFileParameter

public static ParsedParameter makeFakeIndexedFileParameter(String fieldName,
 int index)

makeFakeNonIndexedFileParameter

public static ParsedParameter makeFakeNonIndexedFileParameter(String fieldName)

makeFakeIndexedParameter

public static ParsedParameter makeFakeIndexedParameter(String fieldName,
 int index,
 String parameterValue)

makeFakeNonIndexedParameter

public static ParsedParameter makeFakeNonIndexedParameter(String fieldName,
 String parameterValue)

makeIndexedFileParameter

public static ParsedParameter makeIndexedFileParameter(String fieldName,
 int index,
 UploadedFile uploadedFile)

makeIndexedParameter

public static ParsedParameter makeIndexedParameter(String fieldName,
 int index,
 String parameterValue)

makeNonIndexedFileParameter

public static ParsedParameter makeNonIndexedFileParameter(String fieldName,
 UploadedFile uploadedFile)

makeNonIndexedParameter

public static ParsedParameter makeNonIndexedParameter(String fieldName,
 String parameterValue)

getParameterName

public String getParameterName()

Returns original parameter name.

setParameterName

public void setParameterName(String parameterName)

getParameterValue

public String getParameterValue()

Returns parameter value, which will be empty string for fake, non-file placeholders, or null file parameters.

setParameterValue

public void setParameterValue(String parameterValue)

getFake

public boolean getFake()

Returns whether this is a fake placeholder, not a parameter submitted by the user.

setFake

public void setFake(boolean fake)

getFile

public boolean getFile()

Returns whether this is a file parameter created by FileUploadInterceptor.

setFile

public void setFile(boolean file)

getUploadedFile

public UploadedFile getUploadedFile()

Returns file data created FileUploadInterceptor. Null for non-file parameters or fake placeholders.

setUploadedFile

public void setUploadedFile(UploadedFile uploadedFile)

getFieldName

public String getFieldName()

Returns field name extracted from parameter name.

setFieldName

public void setFieldName(String fieldName)

getHasIndex

public boolean getHasIndex()

Returns whether an index was extracted and parsed from the parameter name.

setHasIndex

public void setHasIndex(boolean hasIndex)

getIndex

public int getIndex()

Returns index within parent FieldParsedParameterList list, which will be the index extracted from parameter name, if found.

setIndex

public void setIndex(int index)

toString

public String toString()

Overrides:

toString in class Object