b4j.util

Class UrlParameters

java.lang.Object

b4j.util.UrlParameters

public class UrlParameters
extends Object

Collects information about URL parameters. The object can be used to produce the URL-encoded-scheme form of parameters. It supports multiple values per parameter.

Author:

Ralph Schuster

Constructor Summary

Constructors

Constructor and Description
UrlParameters() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAll(Map<String,List<String>> p) Adds all parameters.
void	addAll(String key, List<String> values) Adds all values of a parameter.
void	addDefaultParameters(UrlParameters defaults) Adds default parameters.
static UrlParameters	createUrlParameters(SearchData searchData) Creates URL parameters out of the Bugzilla search data.
List<String>	getParameter(String key) Returns a list of all values of this parameter (or null)
Iterator<String>	getParameters() Returns iterator of all parameter names.
String	getUrlEncodedString() Returns the URL encoded string of this parameters.
static String	getUrlEncodedString(Map<String,List<String>> parameters) Returns the URL encoded string of the parameters.
void	removeParameter(String key) Removes a parameter.
void	removeParameter(String key, String value) Removes a value from a parameter.
void	setParameter(String key, String value) Sets a specific parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlParameters

public UrlParameters()

Default constructor.

Method Detail

setParameter

public void setParameter(String key,
                String value)

Sets a specific parameter. Actually just adds it.

Parameters:

key - - name of parameter

value - - value to add

getParameter

public List<String> getParameter(String key)

Returns a list of all values of this parameter (or null)

Parameters:

key - - name of parameter

Returns:

list of values for this parameter

getParameters

public Iterator<String> getParameters()

Returns iterator of all parameter names.

Returns:

iterator on all parameter names

addAll

public void addAll(String key,
          List<String> values)

Adds all values of a parameter.

Parameters:

key - - name of parameter

values - - values to add

addAll

public void addAll(Map<String,List<String>> p)

Adds all parameters.

Parameters:

p - - list of parameters

removeParameter

public void removeParameter(String key,
                   String value)

Removes a value from a parameter.

Parameters:

key - - name of parameter

value - - value to remove

removeParameter

public void removeParameter(String key)

Removes a parameter.

Parameters:

key - - parameter to remove

getUrlEncodedString

public String getUrlEncodedString()

Returns the URL encoded string of this parameters.

Returns:

the URL encoded string of the parameters

addDefaultParameters

public void addDefaultParameters(UrlParameters defaults)

Adds default parameters. Only thos parameters will be applied that are not set yet.

Parameters:

defaults - - default parameters to apply.

createUrlParameters

public static UrlParameters createUrlParameters(SearchData searchData)

Creates URL parameters out of the Bugzilla search data. This method returns an UrlParameters object created from the search parameters and their respective values.

Parameters:

searchData - - the search data to transform

Returns:

URL parameters object

getUrlEncodedString

public static String getUrlEncodedString(Map<String,List<String>> parameters)

Returns the URL encoded string of the parameters.

Parameters:

parameters - - parameter list

Returns:

URL encoded string