com.github.restdriver.serverdriver.http

Class ImmutableUrl

java.lang.Object

com.github.restdriver.serverdriver.http.ImmutableUrl

public final class ImmutableUrl
extends Object

Immutable version of the Url class. Methods do not modify the url but return new modified copies.

Author:

mjg 21/12/2012

Constructor Summary

Constructors

Constructor and Description
ImmutableUrl(String base) Setup an ImmutableUrl with a base path, like "http://localhost:8080".

Method Summary

Methods

Modifier and Type	Method and Description
String	toString() You can pass this object to all the get/post/put/delete etc methods.
ImmutableUrl	withParam(String key, String value) Adds a query-string parameter to the end of the url, like ?key=val.
ImmutableUrl	withPath(String path) Add a path to a url.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImmutableUrl

public ImmutableUrl(String base)

Setup an ImmutableUrl with a base path, like "http://localhost:8080". You can also supply just "localhost" and the "http" will be inferred.

Parameters:

base - the base Url.

Method Detail

withPath

public ImmutableUrl withPath(String path)

Add a path to a url. This method ensures that there is always exactly one "/" character between segments (so you don't have to :).

Parameters:

path - the path, eg "foo/bar"

Returns:

The new ImmutableUrl object (for chaining calls)

withParam

public ImmutableUrl withParam(String key,
                     String value)

Adds a query-string parameter to the end of the url, like ?key=val.

Parameters:

key - The key for the query string.

value - The value for the query string.

Returns:

The Url with the query string param added (for chaining calls)

toString

public String toString()

You can pass this object to all the get/post/put/delete etc methods.

Overrides:

toString in class Object

Returns:

The textual representation of the Url, correctly formatted.