com.ocpsoft.pretty.faces.url

Class QueryString

java.lang.Object

com.ocpsoft.pretty.faces.url.QueryString

public class QueryString
extends Object

Author:

Lincoln Baxter, III

Constructor Summary

Constructors

Constructor and Description
QueryString()

Method Summary

Methods

Modifier and Type	Method and Description
<T extends RequestParameter> void	addParameters(List<T> params) Add query parameters from the given list of RequestParameter objects.
void	addParameters(Map<String,String[]> params) Add parameters from the given map of name=value pairs.
void	addParameters(String url) Add parameters from the given URL.
static <T extends RequestParameter> QueryString	build(List<T> params) Build a query string from the given list of RequestParameter objects.
static QueryString	build(Map<String,String[]> params) Build a query string from the given map of name=value pairs.
static QueryString	build(String url) Build a query string from the given URL.
String	getParameter(String name) Get the first value of given parameter name.
Map<String,String[]>	getParameterMap() Get the name, values[] map representing this query string.
Enumeration<String>	getParameterNames() Get the list of parameter names currently stored in this query string..
String[]	getParameterValues(String name) Get the array of values for a given parameter name.
boolean	isEmpty() Return true if this query string currently contains no parameters.
List<String>	removeParameter(String string)
String	toQueryString() Convert the current parameters to a valid query string, including the leading '?' character.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryString

public QueryString()

Method Detail

build

public static QueryString build(Map<String,String[]> params)

Build a query string from the given map of name=value pairs. For parameters with more than one value, each value will be appended using the same name.

build

public static <T extends RequestParameter> QueryString build(List<T> params)

Build a query string from the given list of RequestParameter objects.

build

public static QueryString build(String url)

Build a query string from the given URL. If a '?' character is encountered in the URL, the any characters up to and including the first '?' will be ignored.

isEmpty

public boolean isEmpty()

Return true if this query string currently contains no parameters.

getParameter

public String getParameter(String name)

Get the first value of given parameter name.

Returns:

The value of the parameter, null if the parameter does not exist, or "" if the parameter exists but has no values.

getParameterValues

public String[] getParameterValues(String name)

Get the array of values for a given parameter name.

Returns:

The values of the parameter, null if the parameter does not exist.

getParameterNames

public Enumeration<String> getParameterNames()

Get the list of parameter names currently stored in this query string..

getParameterMap

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

Get the name, values[] map representing this query string.

addParameters

public <T extends RequestParameter> void addParameters(List<T> params)

Add query parameters from the given list of RequestParameter objects. If a parameter already exists, append new values to the existing list of values for that parameter.

addParameters

public void addParameters(Map<String,String[]> params)

Add parameters from the given map of name=value pairs. For parameters with more than one value, each value will be appended using the same name. If a parameter already exists, append new values to the existing list of values for that parameter.

addParameters

public void addParameters(String url)

Add parameters from the given URL. If a '?' character is encountered in the URL, the any characters up to and including the first '?' will be ignored. If a parameter already exists, append new values to the existing list of values for that parameter.

toQueryString

public String toQueryString()

Convert the current parameters to a valid query string, including the leading '?' character. This method automatically URLEncodes query-parameter values

For example, a QueryString with the values [key=>value, name=>value1,value2,value3] will become:

 
 ?key=value&name=value1&name=value2&name=value3
 

Returns:

If parameters exist, return a valid query string with leading '?' character. If no parameters exist, return an empty string.

toString

public String toString()

Overrides:

toString in class Object

removeParameter

public List<String> removeParameter(String string)