org.bridje.http

Interface HttpReqParam

public interface HttpReqParam

Represents an HTTP POST or GET parameter sent to the server.

Method Summary

Modifier and Type	Method and Description
String[]	getAllValues() If this parameter is multiple this method will return all of the values that were sent to the server under it´s name.
String	getFirst() Gets the first value sent to the server with the name of this parameter.
String	getName() The name of this parameter.
String	getValue() If this parameter is multiple this method will return a value according to an internal cursor.
boolean	isEmpty() Determines if the first value sent to the server is an empty string.
boolean	isMultiple() Determines when ever this parameter has multiple values, this is if the client sent several values with the name of this parameter.
boolean	isSingle() Determines when ever this parameter has a single value.
String	popValue() If this parameter is multiple this method will return a value according to an internal cursor and increment the cursor position.
void	reset() Reset the internal cursor to position 0

Method Detail

getName

String getName()

The name of this parameter.

Returns:

An string representing the name.

isSingle

boolean isSingle()

Determines when ever this parameter has a single value. This method will return the contrary of the isMultiple method.

Returns:

true if only one value were sent to the server.

isMultiple

boolean isMultiple()

Determines when ever this parameter has multiple values, this is if the client sent several values with the name of this parameter. In this case the getAllValues will return all of this values. This method will return the contrary of the isSingle method.

Returns:

true if several values were sent to the server with the name of this parameter.

getFirst

String getFirst()

Gets the first value sent to the server with the name of this parameter.

Returns:

The string representation of the first value or null if the parameter has no values.

getValue

String getValue()

If this parameter is multiple this method will return a value according to an internal cursor.

Returns:

The string representation of the current value of parameter or null if the parameter has no more values.

popValue

String popValue()

If this parameter is multiple this method will return a value according to an internal cursor and increment the cursor position. If this parameter is single this method will return the value only the first time is called.

Returns:

The string representation of the current value of parameter or null if the parameter has no more values.

reset

void reset()

Reset the internal cursor to position 0

getAllValues

String[] getAllValues()

If this parameter is multiple this method will return all of the values that were sent to the server under it´s name.

Returns:

The string array with all the values for this parameter.

isEmpty

boolean isEmpty()

Determines if the first value sent to the server is an empty string.

Returns:

true the first value sent to the server is an empty string, false otherwise.