at.molindo.utils.tools

Class UrlBuilder

java.lang.Object

at.molindo.utils.tools.UrlBuilder

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class UrlBuilder
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

helps building URLs following the format: ${protocol}://[${user}[:${password}]@]${host}[:${port}]${path}[?${query}][#${ fragment}]

Author:

stf@molindo.at

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FTP
static java.lang.String	HTTP
static java.lang.String	HTTPS

Constructor Summary

Constructors

Constructor and Description
UrlBuilder() http://example.com/
UrlBuilder(java.lang.String host) http://{host}/
UrlBuilder(java.lang.String protocol, java.lang.String host) {protocol}://{host}/
UrlBuilder(java.lang.String protocol, java.lang.String host, java.lang.String path) {protocol}://{host}{path}
UrlBuilder(java.net.URL url)

Method Summary

Methods

Modifier and Type	Method and Description
UrlBuilder	addParam(java.lang.String key, java.lang.String value)
UrlBuilder	addParams(java.util.LinkedHashMap<java.lang.String,java.util.List<java.lang.String>> params)
UrlBuilder	addParams(java.lang.String key, java.util.List<java.lang.String> values)
UrlBuilder	addParams(java.lang.String key, java.lang.String... values)
void	clearParams()
UrlBuilder	clone()
static java.lang.String	decode(URLCoder decoder, java.lang.String s)
static java.util.List<java.lang.String>	decodeAll(URLCoder decoder, java.util.List<java.lang.String> list)
static java.lang.String	encode(URLCoder encoder, java.lang.String s)
static java.util.List<java.lang.String>	encodeAll(URLCoder encoder, java.util.List<java.lang.String> list)
java.lang.String	getHost()
java.util.LinkedHashMap<java.lang.String,java.util.List<java.lang.String>>	getParams()
java.lang.String	getPassword()
java.lang.String	getPath()
java.lang.Integer	getPort()
java.lang.String	getProtocol()
java.lang.String	getUser()
static UrlBuilder	parse(java.lang.String url)
static java.util.LinkedHashMap<java.lang.String,java.util.List<java.lang.String>>	parseQuery(java.lang.String query)
UrlBuilder	removeParams(java.lang.String key)
UrlBuilder	resolve(java.lang.String relativePath)
UrlBuilder	setFragment(java.lang.String fragment)
UrlBuilder	setHost(java.lang.String host)
UrlBuilder	setParam(java.lang.String key, java.lang.String value)
UrlBuilder	setParams(java.util.LinkedHashMap<java.lang.String,java.util.List<java.lang.String>> params)
UrlBuilder	setParams(java.lang.String key, java.util.List<java.lang.String> values)
UrlBuilder	setParams(java.lang.String key, java.lang.String... values)
UrlBuilder	setPassword(java.lang.String password)
UrlBuilder	setPath(java.lang.String path)
UrlBuilder	setPort(java.lang.Integer port)
UrlBuilder	setProtocol(java.lang.String protocol)
UrlBuilder	setQuery(java.lang.String query)
protected UrlBuilder	setUrl(java.net.URL url)
UrlBuilder	setUser(java.lang.String user)
java.lang.String	toString()
java.net.URL	toURL()
java.lang.String	toUrlString()
java.lang.String	toUrlString(boolean sortParams)

Methods inherited from class java.lang.Object

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

Field Detail

HTTP

public static final java.lang.String HTTP

See Also:

Constant Field Values

HTTPS

public static final java.lang.String HTTPS

See Also:

Constant Field Values

FTP

public static final java.lang.String FTP

See Also:

Constant Field Values

Constructor Detail

UrlBuilder

public UrlBuilder()

http://example.com/

UrlBuilder

public UrlBuilder(java.lang.String host)

http://{host}/

UrlBuilder

public UrlBuilder(java.lang.String protocol,
          java.lang.String host)

{protocol}://{host}/

UrlBuilder

public UrlBuilder(java.lang.String protocol,
          java.lang.String host,
          java.lang.String path)

{protocol}://{host}{path}

UrlBuilder

public UrlBuilder(java.net.URL url)

Method Detail

parse

public static UrlBuilder parse(java.lang.String url)
                        throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

parseQuery

public static java.util.LinkedHashMap<java.lang.String,java.util.List<java.lang.String>> parseQuery(java.lang.String query)

encode

public static java.lang.String encode(URLCoder encoder,
                      java.lang.String s)

encodeAll

public static java.util.List<java.lang.String> encodeAll(URLCoder encoder,
                                         java.util.List<java.lang.String> list)

decode

public static java.lang.String decode(URLCoder decoder,
                      java.lang.String s)

decodeAll

public static java.util.List<java.lang.String> decodeAll(URLCoder decoder,
                                         java.util.List<java.lang.String> list)

setUrl

protected UrlBuilder setUrl(java.net.URL url)

setProtocol

public UrlBuilder setProtocol(java.lang.String protocol)

setUser

public UrlBuilder setUser(java.lang.String user)

setPassword

public UrlBuilder setPassword(java.lang.String password)

setHost

public UrlBuilder setHost(java.lang.String host)

setPort

public UrlBuilder setPort(java.lang.Integer port)

setPath

public UrlBuilder setPath(java.lang.String path)

setQuery

public UrlBuilder setQuery(java.lang.String query)

setParams

public UrlBuilder setParams(java.util.LinkedHashMap<java.lang.String,java.util.List<java.lang.String>> params)

addParams

public UrlBuilder addParams(java.util.LinkedHashMap<java.lang.String,java.util.List<java.lang.String>> params)

setParam

public UrlBuilder setParam(java.lang.String key,
                  java.lang.String value)

setParams

public UrlBuilder setParams(java.lang.String key,
                   java.lang.String... values)

setParams

public UrlBuilder setParams(java.lang.String key,
                   java.util.List<java.lang.String> values)

addParam

public UrlBuilder addParam(java.lang.String key,
                  java.lang.String value)

addParams

public UrlBuilder addParams(java.lang.String key,
                   java.lang.String... values)

addParams

public UrlBuilder addParams(java.lang.String key,
                   java.util.List<java.lang.String> values)

removeParams

public UrlBuilder removeParams(java.lang.String key)

clearParams

public void clearParams()

setFragment

public UrlBuilder setFragment(java.lang.String fragment)

resolve

public UrlBuilder resolve(java.lang.String relativePath)

toUrlString

public java.lang.String toUrlString()

toUrlString

public java.lang.String toUrlString(boolean sortParams)

toURL

public java.net.URL toURL()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public UrlBuilder clone()

Overrides:

clone in class java.lang.Object

getProtocol

public java.lang.String getProtocol()

getUser

public java.lang.String getUser()

getPassword

public java.lang.String getPassword()

getHost

public java.lang.String getHost()

getPort

public java.lang.Integer getPort()

getPath

public java.lang.String getPath()

getParams

public java.util.LinkedHashMap<java.lang.String,java.util.List<java.lang.String>> getParams()