spark

Class QueryParamsMap

java.lang.Object

spark.QueryParamsMap

public class QueryParamsMap
extends Object

This objects represent the parameters sent on a Http Request.
Parses parameters keys like in Sinatra.

For a querystring like:
user[name]=federico&user[lastname]=dayan

We get would get a structure like:
user : {name: federico, lastname: dayan}

That is:
queryParamsMapInstance.get("user).get("name").value();
queryParamsMapInstance.get("user).get("lastname").value();

It is null safe, meaning that if a key does not exist, it does not throw NullPointerExcetpion , it just returns null.

Author:

fddayan

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueryParamsMap()
	QueryParamsMap(javax.servlet.http.HttpServletRequest request) Creates a new QueryParamsMap from and HttpServletRequest.
protected	QueryParamsMap(Map<String,String[]> params)
protected	QueryParamsMap(String key, String... values) Parses the key and creates the child QueryParamMaps user[info][name] creates 3 nested QueryParamMaps.

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	booleanValue()
protected static String	cleanKey(String group)
Double	doubleValue()
Float	floatValue()
QueryParamsMap	get(String... keys) Retruns and element fro the specified key.
boolean	hasKeys()
boolean	hasValue()
Integer	integerValue()
protected void	loadKeys(String key, String[] value)
protected void	loadQueryString(Map<String,String[]> params)
Long	longValue()
protected String[]	parseKey(String key)
Map<String,String[]>	toMap()
String	value() Returns the value for this key.
String	value(String... keys) Returns the value for that key.
String[]	values()

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryParamsMap

public QueryParamsMap(javax.servlet.http.HttpServletRequest request)

Creates a new QueryParamsMap from and HttpServletRequest.
Parses the parameters from request.getParameterMap()
No need to decode, since HttpServletRequest does it for us.

Parameters:

request -

QueryParamsMap

protected QueryParamsMap()

QueryParamsMap

protected QueryParamsMap(String key,
              String... values)

Parses the key and creates the child QueryParamMaps user[info][name] creates 3 nested QueryParamMaps. For user, info and name.

Parameters:

key - The key in the formar fo key1[key2][key3] (for example: user[info][name]).

values -

QueryParamsMap

protected QueryParamsMap(Map<String,String[]> params)

Method Detail

loadQueryString

protected final void loadQueryString(Map<String,String[]> params)

loadKeys

protected final void loadKeys(String key,
            String[] value)

parseKey

protected final String[] parseKey(String key)

cleanKey

protected static final String cleanKey(String group)

get

public QueryParamsMap get(String... keys)

Retruns and element fro the specified key.
For querystring:

user[name]=fede

get("user").get("name").value() # fede
or
get("user","name").value() # fede

Parameters:

key - The paramater nested key

Returns:

value

public String value()

Returns the value for this key.
If this key has nested elements and does not have a value returns null.

Returns:

value

public String value(String... keys)

Returns the value for that key.
It is a shortcut for:

get("user").get("name").value() get("user").value("name")

Parameters:

key -

Returns:

hasKeys

public boolean hasKeys()

hasValue

public boolean hasValue()

booleanValue

public Boolean booleanValue()

integerValue

public Integer integerValue()

longValue

public Long longValue()

floatValue

public Float floatValue()

doubleValue

public Double doubleValue()

values

public String[] values()

toMap

public Map<String,String[]> toMap()