org.josef.web

Class QueryString

java.lang.Object

org.josef.web.QueryString

All Implemented Interfaces:

Serializable

public final class QueryString
extends Object
implements Serializable

Abstraction of a query string.
The query string is part of an url, for example in: http://server/path/program?queryString&name=value
The query string is: queryString&name=value. The question mark is not part of the query string, it is a separator. This class allows you to build a query string from name/value pairs.
For an article on URL encoding see: What every web developer must know about URL encoding

Version:

1.0 $Revision: 5814 $

Author:

Kees Schotanus

See Also:

QueryStringUtil, Serialized Form

Constructor Summary

Constructors

Constructor and Description
QueryString() Private constructor prevents creation of an instance outside this class.

Method Summary

Modifier and Type	Method and Description
QueryString	add(String name, String value) Adds the supplied name and value to this query string.
String	toString() Creates a String representation of this query string.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryString

public QueryString()

Private constructor prevents creation of an instance outside this class.

Method Detail

add

public QueryString add(String name,
                       String value)

Adds the supplied name and value to this query string.
For example:

 QueryString query = new QueryString();
 query.add("age", "41");
 query.add"gender", "M");

Note: This method does not guard against adding the same name twice.

Parameters:

name - Name of the query parameter to add.
The name will be encoded automatically.

value - Value of the query parameter to add.
The value will be encoded automatically.
Supplying null will result in not adding a value.

Returns:

Augmented Query string.

Throws:

IllegalArgumentException - When the supplied name is empty.

NullPointerException - When the supplied name is null.

toString

public String toString()

Creates a String representation of this query string.
Note: Even though the question mark is technically not part of the query string, it is returned here for your convenience.

Overrides:

toString in class Object

Returns:

An empty String when no add has been performed, in all other cases a String adhering to the following regular expression: ?name=[value](&name=[value])* is returned.
The returned String is UTF-8 encoded.