sirius.kernel.commons

Class URLBuilder

java.lang.Object

sirius.kernel.commons.URLBuilder

public class URLBuilder
extends Object

Used to succesively build URLs.

The major advantage is to be able to add parameters without caring if a '?' or a '&' has to be used.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROTOCOL_HTTP Can be used to specify the HTTP protocol in URLBuilder(String, String).
static String	PROTOCOL_HTTPS Can be used to specify the HTTPS protocol in URLBuilder(String, String).

Constructor Summary

Constructors

Constructor and Description
URLBuilder(String baseURL) Creates a new instance pre filled with the given baseURL.
URLBuilder(String protocol, String host) Creates a new instance targeting the given host using the given protocol.

Method Summary

Modifier and Type	Method and Description
URLBuilder	addParameter(String key, Object value) Adds a parameter to the url.
URLBuilder	addParameter(String key, Object value, boolean urlEncode) Adds a parameter to the url.
URLBuilder	addPart(String... uriPartsToAdd) Adds a path part to the url.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PROTOCOL_HTTP

public static final String PROTOCOL_HTTP

Can be used to specify the HTTP protocol in URLBuilder(String, String).

See Also:

Constant Field Values

PROTOCOL_HTTPS

public static final String PROTOCOL_HTTPS

Can be used to specify the HTTPS protocol in URLBuilder(String, String).

See Also:

Constant Field Values

Constructor Detail

URLBuilder

public URLBuilder(@Nonnull
                  String baseURL)

Creates a new instance pre filled with the given baseURL.

Parameters:

baseURL - the base url to stat with in a form like http://somehost.com

URLBuilder

public URLBuilder(@Nonnull
                  String protocol,
                  @Nonnull
                  String host)

Creates a new instance targeting the given host using the given protocol.

Parameters:

protocol - the protocol (http, https) to use

host - the host to target.

Method Detail

addPart

public URLBuilder addPart(@Nonnull
                          String... uriPartsToAdd)

Adds a path part to the url.

Once the first parameter has been added, the path can no longer be modified.

Parameters:

uriPartsToAdd - the uri part to add. This should not contain a leading '/' as it is added automatically. If an array (vararg) is given, all components are appended to the internal StringBuilder without any additional characters.

Returns:

the builder itself for fluent method calls

addParameter

public URLBuilder addParameter(@Nonnull
                               String key,
                               @Nullable
                               Object value)

Adds a parameter to the url.

Parameters:

key - the name of the parameter

value - the value of the parameter which will be url encoded. If the given value is null an empty parameter will be added.

Returns:

the builder itself for fluent method calls

addParameter

public URLBuilder addParameter(@Nonnull
                               String key,
                               @Nullable
                               Object value,
                               boolean urlEncode)

Adds a parameter to the url.

Parameters:

key - the name of the parameter

value - the value of the parameter . If the given value is null an empty parameter will be added.

urlEncode - true if the given value should be url encoded before adding

Returns:

the builder itself for fluent method calls

toString

public String toString()

Overrides:

toString in class Object