org.baswell.routes
Class RequestParameters

java.lang.Object
  org.baswell.routes.RequestParameters

public class RequestParameters
extends java.lang.Object

The parameters from an HTTP request. Default parameters for a route (Route.defaultParameters()) will be present for any parameters not explicitly set in the HTTP request.

Method Summary

boolean	contains(java.lang.String name)
java.lang.String	get(java.lang.String name)
java.lang.String	get(java.lang.String name, java.lang.String defaultValue)
java.lang.Boolean	getBoolean(java.lang.String name)
java.lang.Boolean	getBoolean(java.lang.String name, java.lang.Boolean defaultValue)
java.util.List<java.lang.Boolean>	getBooleans(java.lang.String name)
java.lang.Byte	getByte(java.lang.String name)
java.lang.Byte	getByte(java.lang.String name, java.lang.Byte defaultValue)
java.util.List<java.lang.Byte>	getBytes(java.lang.String name)
java.lang.Character	getCharacter(java.lang.String name)
java.lang.Character	getCharacter(java.lang.String name, java.lang.Character defaultValue)
java.util.List<java.lang.Character>	getCharacters(java.lang.String name)
java.lang.Double	getDouble(java.lang.String name)
java.lang.Double	getDouble(java.lang.String name, java.lang.Double defaultValue)
java.util.List<java.lang.Double>	getDoubles(java.lang.String name)
java.lang.Float	getFloat(java.lang.String name)
java.lang.Float	getFloat(java.lang.String name, java.lang.Float defaultValue)
java.util.List<java.lang.Float>	getFloats(java.lang.String name)
java.lang.Integer	getInt(java.lang.String name, java.lang.Integer defaultValue)
java.lang.Integer	getInteger(java.lang.String name)
java.util.List<java.lang.Integer>	getIntegers(java.lang.String name)
java.lang.Long	getLong(java.lang.String name)
java.lang.Long	getLong(java.lang.String name, java.lang.Long defaultValue)
java.util.List<java.lang.Long>	getLongs(java.lang.String name)
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getParameterListMap()
java.util.Map<java.lang.String,java.lang.String>	getParameterMap() Parameters with multiple values will only contain one value in this map.
java.lang.Short	getShort(java.lang.String name)
java.lang.Short	getShort(java.lang.String name, java.lang.Short defaultValue)
java.util.List<java.lang.Short>	getShorts(java.lang.String name)
java.util.List<java.lang.String>	getValues(java.lang.String name)
boolean	hasParameters()
int	size()
int	size(java.lang.String name)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

hasParameters

public boolean hasParameters()

Returns:

size() > 0

size

public int size()

Returns:

The number of parameters.

size

public int size(java.lang.String name)

Parameters:

name - The name of the parameter

Returns:

The number parameter values for the given parameter name.

contains

public boolean contains(java.lang.String name)

Parameters:

name - The parameter name.

Returns:

True if a value for the given parameter name exists.

getParameterListMap

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

Returns:

A parameter map where the key is the parameter name and the value is the parameter values.

getParameterMap

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

Parameters with multiple values will only contain one value in this map.

Returns:

A parameter map where the key is the parameter name and the value is the parameter value.

get

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

Parameters:

name - The parameter name.

Returns:

The parameter value or null if not present.

get

public java.lang.String get(java.lang.String name,
                            java.lang.String defaultValue)

Parameters:

name - The parameter name.

defaultValue - The default value to return if the given parameter is not present.

Returns:

The parameter value or defaultValue if not present.

getValues

public java.util.List<java.lang.String> getValues(java.lang.String name)

Parameters:

name - The parameter name.

Returns:

The parameter values for the given name. If no values for the given parameter exists an empty list is returned.

getCharacter

public java.lang.Character getCharacter(java.lang.String name)

Parameters:

name - The parameter name

Returns:

The first character of the parameter value or null if the given parameter doesn't exist.

getCharacter

public java.lang.Character getCharacter(java.lang.String name,
                                        java.lang.Character defaultValue)

Parameters:

name - The parameter name

defaultValue - The value to return if the parameter doesn't exists.

Returns:

The first character of the parameter value or the given defaultValue if the given parameter doesn't exist.

getCharacters

public java.util.List<java.lang.Character> getCharacters(java.lang.String name)

Parameters:

name - The parameter name.

Returns:

Each parameter value as a Character for the given name. If no values for the given parameter exists an empty list is returned.

getBoolean

public java.lang.Boolean getBoolean(java.lang.String name)

Parameters:

name - The parameter name

Returns:

The parameter value parsed as a Boolean or null if the given parameter doesn't exist.

See Also:

Boolean.parseBoolean(String)

getBoolean

public java.lang.Boolean getBoolean(java.lang.String name,
                                    java.lang.Boolean defaultValue)

Parameters:

name - The parameter name

defaultValue - The value to return if the parameter doesn't exists

Returns:

The parameter value parsed as a Boolean or the given defaultValue if the given parameter doesn't exist.

See Also:

Boolean.parseBoolean(String)

getBooleans

public java.util.List<java.lang.Boolean> getBooleans(java.lang.String name)

Parameters:

name - The parameter name.

Returns:

Each parameter value parsed into a Boolean for the given name. If no values for the given parameter exists an empty list is returned.

See Also:

Boolean.parseBoolean(String)

getByte

public java.lang.Byte getByte(java.lang.String name)
                       throws java.lang.NumberFormatException

Parameters:

name - The parameter name

Returns:

The parameter value parsed as a Byte or null if the given parameter doesn't exist.

Throws:

java.lang.NumberFormatException - If the parameter value cannot be parsed into a Byte.

See Also:

Byte.parseByte(String)

getByte

public java.lang.Byte getByte(java.lang.String name,
                              java.lang.Byte defaultValue)
                       throws java.lang.NumberFormatException

Parameters:

name - The parameter name

defaultValue - The default value to return if the parameter doesn't exists.

Returns:

The parameter value parsed as a Byte or the given defaultValue if the given parameter doesn't exist.

Throws:

java.lang.NumberFormatException - If the parameter value cannot be parsed into a Byte.

See Also:

Byte.parseByte(String)

getBytes

public java.util.List<java.lang.Byte> getBytes(java.lang.String name)
                                        throws java.lang.NumberFormatException

Parameters:

name - The parameter name.

Returns:

Each parameter value parsed into a Byte for the given name. If no values for the given parameter exists an empty list is returned.

Throws:

java.lang.NumberFormatException - If one of the parameter values cannot be parsed into a Byte.

See Also:

Byte.parseByte(String)

getShort

public java.lang.Short getShort(java.lang.String name)
                         throws java.lang.NumberFormatException

Parameters:

name - The parameter name

Returns:

The parameter value parsed as a Short or null if the given parameter doesn't exist.

Throws:

java.lang.NumberFormatException - If the parameter value cannot be parsed into a Short.

See Also:

Short.parseShort(String)

getShort

public java.lang.Short getShort(java.lang.String name,
                                java.lang.Short defaultValue)
                         throws java.lang.NumberFormatException

Parameters:

name - The parameter name

defaultValue - The default value to return if the parameter doesn't exists.

Returns:

The parameter value parsed as a Short or the given defaultValue if the given parameter doesn't exist.

Throws:

java.lang.NumberFormatException - If the parameter value cannot be parsed into a Short.

See Also:

Short.parseShort(String)

getShorts

public java.util.List<java.lang.Short> getShorts(java.lang.String name)
                                          throws java.lang.NumberFormatException

Parameters:

name - The parameter name.

Returns:

Each parameter value parsed into a Short for the given name. If no values for the given parameter exists an empty list is returned.

Throws:

java.lang.NumberFormatException - If one of the parameter values cannot be parsed into a Short.

See Also:

Short.parseShort(String)

getInteger

public java.lang.Integer getInteger(java.lang.String name)
                             throws java.lang.NumberFormatException

Parameters:

name - The parameter name

Returns:

The parameter value parsed as a Integer or null if the given parameter doesn't exist.

Throws:

java.lang.NumberFormatException - If the parameter value cannot be parsed into a Integer.

See Also:

Integer.parseInt(String)

getInt

public java.lang.Integer getInt(java.lang.String name,
                                java.lang.Integer defaultValue)
                         throws java.lang.NumberFormatException

Parameters:

name - The parameter name

defaultValue - The default value to return if the parameter doesn't exists.

Returns:

The parameter value parsed as a Integer or the given defaultValue if the given parameter doesn't exist.

Throws:

java.lang.NumberFormatException - If the parameter value cannot be parsed into a Integer.

See Also:

Integer.parseInt(String)

getIntegers

public java.util.List<java.lang.Integer> getIntegers(java.lang.String name)
                                              throws java.lang.NumberFormatException

Parameters:

name - The parameter name.

Returns:

Each parameter value parsed into a Integer for the given name. If no values for the given parameter exists an empty list is returned.

Throws:

java.lang.NumberFormatException - If one of the parameter values cannot be parsed into a Integer.

See Also:

Integer.parseInt(String)

getLong

public java.lang.Long getLong(java.lang.String name)
                       throws java.lang.NumberFormatException

Parameters:

name - The parameter name

Returns:

The parameter value parsed as a Long or null if the given parameter doesn't exist.

Throws:

java.lang.NumberFormatException - If the parameter value cannot be parsed into a Long.

See Also:

Long.parseLong(String)

getLong

public java.lang.Long getLong(java.lang.String name,
                              java.lang.Long defaultValue)
                       throws java.lang.NumberFormatException

Parameters:

name - The parameter name

defaultValue - The default value to return if the parameter doesn't exists.

Returns:

The parameter value parsed as a Long or the given defaultValue if the given parameter doesn't exist.

Throws:

java.lang.NumberFormatException - If the parameter value cannot be parsed into a Long.

See Also:

Long.parseLong(String)

getLongs

public java.util.List<java.lang.Long> getLongs(java.lang.String name)
                                        throws java.lang.NumberFormatException

Parameters:

name - The parameter name.

Returns:

Each parameter value parsed into a Long for the given name. If no values for the given parameter exists an empty list is returned.

Throws:

java.lang.NumberFormatException - If one of the parameter values cannot be parsed into a Long.

See Also:

Boolean.parseBoolean(String)

getFloat

public java.lang.Float getFloat(java.lang.String name)
                         throws java.lang.NumberFormatException

Parameters:

name - The parameter name

Returns:

The parameter value parsed as a Float or null if the given parameter doesn't exist.

Throws:

java.lang.NumberFormatException - If the parameter value cannot be parsed into a Float.

See Also:

Float.parseFloat(String)

getFloat

public java.lang.Float getFloat(java.lang.String name,
                                java.lang.Float defaultValue)
                         throws java.lang.NumberFormatException

Parameters:

name - The parameter name

defaultValue - The default value to return if the parameter doesn't exists.

Returns:

The parameter value parsed as a Float or the given defaultValue if the given parameter doesn't exist.

Throws:

java.lang.NumberFormatException - If the parameter value cannot be parsed into a Float.

See Also:

Float.parseFloat(String)

getFloats

public java.util.List<java.lang.Float> getFloats(java.lang.String name)
                                          throws java.lang.NumberFormatException

Parameters:

name - The parameter name.

Returns:

Each parameter value parsed into a Float for the given name. If no values for the given parameter exists an empty list is returned.

Throws:

java.lang.NumberFormatException - If one of the parameter values cannot be parsed into a Float.

See Also:

Long.parseLong(String)

getDouble

public java.lang.Double getDouble(java.lang.String name)
                           throws java.lang.NumberFormatException

Parameters:

name - The parameter name

Returns:

The parameter value parsed as a Double or null if the given parameter doesn't exist.

Throws:

java.lang.NumberFormatException - If the parameter value cannot be parsed into a Double.

See Also:

Double.parseDouble(String)

getDouble

public java.lang.Double getDouble(java.lang.String name,
                                  java.lang.Double defaultValue)
                           throws java.lang.NumberFormatException

Parameters:

name - The parameter name

defaultValue - The default value to return if the parameter doesn't exists.

Returns:

The parameter value parsed as a Double or the given defaultValue if the given parameter doesn't exist.

Throws:

java.lang.NumberFormatException - If the parameter value cannot be parsed into a Double.

See Also:

Double.parseDouble(String)

getDoubles

public java.util.List<java.lang.Double> getDoubles(java.lang.String name)
                                            throws java.lang.NumberFormatException

Parameters:

name - The parameter name.

Returns:

Each parameter value parsed into a Double for the given name. If no values for the given parameter exists an empty list is returned.

Throws:

java.lang.NumberFormatException - If one of the parameter values cannot be parsed into a Double.

See Also:

Double.parseDouble(String)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object