org.josef.web

Class QueryStringUtil

java.lang.Object

org.josef.web.QueryStringUtil

@Status(stage=DEVELOPMENT,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",
        at="2012-09-27")
 @ThreadSafety(level=THREAD_SAFE)
public final class QueryStringUtil
extends Object

Query String Utility class.
The query string is part of an url, for example: http://server/path/program?queryString&name=value
The question mark is not part of the query string.
For an article on URL encoding see: What every web developer must know about URL encoding

Version:

1.0 $Revision: 6298 $

Author:

Kees Schotanus

See Also:

QueryString

Method Summary

Modifier and Type	Method and Description
static String	addQueryParameterToUrl(String url, String name, String value) Adds a query parameter (name and value pair) to the supplied url.
static String	decodeUrl(String url) Decodes the supplied url using UTF-8 encoding as recommended by the W3C.
static String	encodeUrl(String url) Encodes the supplied url using UTF-8 encoding as recommended by the W3C.
static String	getQueryString(String url) Gets the raw, un-decoded, query string of the supplied url.
static Map<String,String>	getQueryStringParameters(String queryString) Gets all the parameters from the supplied query string.

Methods inherited from class java.lang.Object

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

Method Detail

getQueryString

public static String getQueryString(String url)

Gets the raw, un-decoded, query string of the supplied url.

Parameters:

url - The url to get the query string from.

Returns:

The query string of the supplied url. The returned query string may be empty but will never be null.
Note: The returned query string does not include the question mark.

Throws:

NullPointerException - When the supplied url is null.

getQueryStringParameters

public static Map<String,String> getQueryStringParameters(String queryString)

Gets all the parameters from the supplied query string.
This method will only work properly when the supplied queryString is just a query string and nothing more. It should for example not contain path parameters, nor fragments.

Parameters:

queryString - The query string to get the query parameters from.
Note: The question mark is not part of the query string!

Returns:

A map of name and value pairs.
The returned map may be empty but will never be null.

Throws:

NullPointerException - When the supplied queryString is null.

addQueryParameterToUrl

public static String addQueryParameterToUrl(String url,
                                            String name,
                                            String value)

Adds a query parameter (name and value pair) to the supplied url.
This method adds the proper symbols, like '?' and '&' to the returned url, plus it prevents you from adding the same parameter twice.

Parameters:

url - The url to which the supplied name and value will be added.

name - Name of the query parameter to add.

value - Value of the query parameter to add.
Supplying null will result in adding an empty string.

Returns:

Supplied url, augmented with the supplied name and value.

Throws:

IllegalArgumentException - When either the supplied url or the supplied name is empty.

NullPointerException - When either the supplied url or the supplied name is null.

encodeUrl

public static String encodeUrl(String url)

Encodes the supplied url using UTF-8 encoding as recommended by the W3C.
Do not use this method to encode complete URL's.

Parameters:

url - The url to encode.

Returns:

The encoded url.

Throws:

NullPointerException - When the supplied url is null.

decodeUrl

public static String decodeUrl(String url)

Decodes the supplied url using UTF-8 encoding as recommended by the W3C.
Do not use this method to encode complete URL's.

Parameters:

url - The url to decode.

Returns:

The encoded url.

Throws:

NullPointerException - When the supplied url is null.