org.codehaus.httpcache4j.util

Class URIBuilder

java.lang.Object

org.codehaus.httpcache4j.util.URIBuilder

public final class URIBuilder
extends Object

Immutable URI builder. Paths in this URI builder will be UTF-8 URIEncoded. Query Parameters needs to be URIEncoded before they are added. All methods return a NEW instance of the URI builder, meaning you can create a ROOT uri builder and use it to your heart's content, as the instance will never change.

Version:

$Revision: $

Author:

Erlend Hamnaberg

Field Summary

Fields

Modifier and Type	Field and Description
static AtomicReference<URISchemeDefaults>	schemeDefaults

Method Summary

Methods

Modifier and Type	Method and Description
URIBuilder	addParameter(Parameter parameter) Adds a new Parameter to the collection of parameters
URIBuilder	addParameter(String name, String value) Adds a new Parameter to the collection of parameters
URIBuilder	addParameters(List<Parameter> parameters) Adds Parameters to the collection of parameters
URIBuilder	addParameters(Map<String,List<String>> params)
URIBuilder	addPath(List<String> path) Appends the path part to the URI.
URIBuilder	addPath(String... path)
URIBuilder	addRawPath(String path) Adds a raw path to the URI.
static URIBuilder	empty() Creates an empty URIBuilder.
URIBuilder	fragment(String fragment) Deprecated.
static URIBuilder	fromURI(URI uri) Constructs a new URIBuilder from the given URI
String	getCurrentPath()
List<String>	getEncodedPath()
String	getFirstParameterValueByName(String name)
String	getFragment()
String	getHost()
List<Parameter>	getParameters()
List<Parameter>	getParametersByName(String name)
List<String>	getPath()
int	getPort()
String	getScheme()
URIBuilder	host(String host) Deprecated.
boolean	isRelative()
URIBuilder	noParameters() Creates a new URIBuilder with no parameters, but all other values retained.
URIBuilder	parameters(List<Parameter> parameters) Deprecated. use #withParameters instead
URIBuilder	path(List<String> pathList) Deprecated.
URIBuilder	path(String... path) Deprecated.
URIBuilder	port(int port) Deprecated.
URIBuilder	rawPath(String path) Deprecated.
URIBuilder	removeParameters(String name)
URIBuilder	replaceParameter(String name, String value)
URIBuilder	scheme(String scheme) Deprecated.
URI	toAbsoluteURI()
URI	toNormalizedURI()
URI	toNormalizedURI(boolean encodePath)
static Map<String,List<String>>	toQueryMap(String query)
URI	toURI()
URIBuilder	withFragment(String fragment)
URIBuilder	withHost(String host)
URIBuilder	withParameters(List<Parameter> parameters) Sets a list of parameters.
URIBuilder	withParameters(Map<String,List<String>> params)
URIBuilder	withPath(List<String> pathList) Sets the path of the uri.
URIBuilder	withPath(String... path)
URIBuilder	withPort(int port) Sets the port.
URIBuilder	withRawPath(String path)
URIBuilder	withScheme(String scheme) This is the scheme to use.

Methods inherited from class java.lang.Object

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

Field Detail

schemeDefaults

public static AtomicReference<URISchemeDefaults> schemeDefaults

Method Detail

scheme

@Deprecated
public URIBuilder scheme(String scheme)

Deprecated.

This is the scheme to use. Usually 'http' or 'https'.

Parameters:

scheme - the scheme

Returns:

a new URIBuilder with the new scheme set.

host

@Deprecated
public URIBuilder host(String host)

Deprecated.

withHost

public URIBuilder withHost(String host)

port

@Deprecated
public URIBuilder port(int port)

Deprecated.

Sets the port. This is not required to set if you are using default ports for 'http' or 'https'

Parameters:

port - the port to set

Returns:

a new URIBuilder with the port set

withPort

public URIBuilder withPort(int port)

Sets the port. This is not required to set if you are using default ports for 'http' or 'https'

Parameters:

port - the port to set

Returns:

a new URIBuilder with the port set

withScheme

public URIBuilder withScheme(String scheme)

This is the scheme to use. Usually 'http' or 'https'.

Parameters:

scheme - the scheme

Returns:

a new URIBuilder with the new scheme set.

addRawPath

public URIBuilder addRawPath(String path)

Adds a raw path to the URI.

Parameters:

path - a path which may contain '/'

Returns:

a new URI builder which contains the added path.

addPath

public URIBuilder addPath(List<String> path)

Appends the path part to the URI. We do not expect the path separator '/' to appear here, as each element will be URLEncoded. If the '/' character do appear it will be URLEncoded with the rest of the path.

Parameters:

path - path elements.

Returns:

a new URI builder which contains the new path.

addPath

public URIBuilder addPath(String... path)

Parameters:

path - path elements

Returns:

a new URI builder which contains the new path.

See Also:

addPath(java.util.List)

path

@Deprecated
public URIBuilder path(String... path)

Deprecated.

Parameters:

path - path elements.

Returns:

a new URI builder which contains the new path.

See Also:

path(java.util.List)

withPath

public URIBuilder withPath(String... path)

Parameters:

path - path elements.

Returns:

a new URI builder which contains the new path.

See Also:

path(java.util.List)

path

@Deprecated
public URIBuilder path(List<String> pathList)

Deprecated.

Sets the path of the uri. We do not expect the path separator '/' to appear here, as each element will be URLEncoded. If the '/' character do appear it will be URLEncoded with the rest of the path.

Parameters:

pathList - path elements.

Returns:

a new URI builder which contains the new path.

withPath

public URIBuilder withPath(List<String> pathList)

Sets the path of the uri. We do not expect the path separator '/' to appear here, as each element will be URLEncoded. If the '/' character do appear it will be URLEncoded with the rest of the path.

Parameters:

pathList - path elements.

Returns:

a new URI builder which contains the new path.

rawPath

@Deprecated
public URIBuilder rawPath(String path)

Deprecated.

Parameters:

path - path elements.

Returns:

a new URI builder which contains the new path.

See Also:

path(java.util.List)

withRawPath

public URIBuilder withRawPath(String path)

Parameters:

path - path elements.

Returns:

a new URI builder which contains the new path.

See Also:

path(java.util.List)

fragment

@Deprecated
public URIBuilder fragment(String fragment)

Deprecated.

withFragment

public URIBuilder withFragment(String fragment)

noParameters

public URIBuilder noParameters()

Creates a new URIBuilder with no parameters, but all other values retained.

Returns:

new URIBuilder with no parameters.

parameters

@Deprecated
public URIBuilder parameters(List<Parameter> parameters)

Deprecated. use #withParameters instead

Sets a list of parameters. This will clear out all previously set parameters in the new instance.

Parameters:

parameters - the list of parameters

Returns:

new URIBuilder with parameters.

withParameters

public URIBuilder withParameters(List<Parameter> parameters)

Sets a list of parameters. This will clear out all previously set parameters in the new instance.

Parameters:

parameters - the list of parameters

Returns:

new URIBuilder with parameters.

withParameters

public URIBuilder withParameters(Map<String,List<String>> params)

addParameter

public URIBuilder addParameter(String name,
                      String value)

Adds a new Parameter to the collection of parameters

Parameters:

name - the parameter name

value - the parameter value

Returns:

a new instance of the URIBuilder

addParameter

public URIBuilder addParameter(Parameter parameter)

Adds a new Parameter to the collection of parameters

Parameters:

parameter - the parameter

Returns:

a new instance of the URIBuilder

addParameters

public URIBuilder addParameters(List<Parameter> parameters)

Adds Parameters to the collection of parameters

Returns:

a new instance of the URIBuilder

addParameters

public URIBuilder addParameters(Map<String,List<String>> params)

removeParameters

public URIBuilder removeParameters(String name)

replaceParameter

public URIBuilder replaceParameter(String name,
                          String value)

toURI

public URI toURI()

toNormalizedURI

public URI toNormalizedURI(boolean encodePath)

toNormalizedURI

public URI toNormalizedURI()

isRelative

public boolean isRelative()

Returns:

true if the scheme and host parts are not set.

toAbsoluteURI

public URI toAbsoluteURI()

getParametersByName

public List<Parameter> getParametersByName(String name)

getFirstParameterValueByName

public String getFirstParameterValueByName(String name)

fromURI

public static URIBuilder fromURI(URI uri)

Constructs a new URIBuilder from the given URI

Parameters:

uri - the uri to use

Returns:

a new URIBuilder which has the information from the URI.

empty

public static URIBuilder empty()

Creates an empty URIBuilder.

Returns:

an empty URIBuilder which result of toURI() ()} will return "".

getScheme

public String getScheme()

getHost

public String getHost()

getPort

public int getPort()

getPath

public List<String> getPath()

getEncodedPath

public List<String> getEncodedPath()

getCurrentPath

public String getCurrentPath()

getFragment

public String getFragment()

getParameters

public List<Parameter> getParameters()

toQueryMap

public static Map<String,List<String>> toQueryMap(String query)