net.eledge.urlbuilder

Class UrlBuilder

java.lang.Object

net.eledge.urlbuilder.UrlBuilder

public class UrlBuilder
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PATH_SEPERATOR

Constructor Summary

Constructors

Constructor and Description
UrlBuilder(java.lang.String url) Create an instance of UrlBuilder with a base url to start with.

Method Summary

Modifier and Type	Method and Description
UrlBuilder	addPage(java.lang.String page) Add page (including extension) to path
UrlBuilder	addParam(java.lang.String key, long value) Add number parameter to url
UrlBuilder	addParam(java.lang.String key, java.lang.String... values) Add parameter with one or more values
UrlBuilder	addParamsFromURL(java.lang.String url, java.lang.String... ignoreKeys) Extract parameters from existing url and add them.
UrlBuilder	addPath(java.lang.String... paths) Add one or more path segments to url.
UrlBuilder	disableDomain() Don't output domain on toString().
UrlBuilder	disableEncoding() Disable default encoding on parameters.
UrlBuilder	disableProtocol() Disable protocol inclusion for toString().
UrlBuilder	disableTrailingSlash() If url ends with a path instead of page by default a / will be added.
boolean	hasParam(java.lang.String key)
UrlBuilder	overrideParam(java.lang.String key, long value)
UrlBuilder	overrideParam(java.lang.String key, java.lang.String... values)
UrlBuilder	removeParam(java.lang.String key)
UrlBuilder	removeParamDefault(java.lang.String key, java.lang.String value) Remove the value of a (multiple) parameter if present
UrlBuilder	removeParamValuesStartWith(java.lang.String key, java.lang.String value) Remove value(s) that start with a given string of a (multiple) parameter if present
UrlBuilder	setAnchor(java.lang.String anchor) Add an anchor to url.
UrlBuilder	setDomain(java.lang.String newDomain) Set the domain of the url
java.lang.String	toCanonicalUrl() Generates the canonical url.
java.lang.String	toString() Generates the url.

Methods inherited from class java.lang.Object

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

Field Detail

PATH_SEPERATOR

public static final java.lang.String PATH_SEPERATOR

See Also:

Constant Field Values

Constructor Detail

UrlBuilder

public UrlBuilder(java.lang.String url)

Create an instance of UrlBuilder with a base url to start with.

Parameters:

url - Base url to start with, can be relative.

Method Detail

disableProtocol

public UrlBuilder disableProtocol()

Disable protocol inclusion for toString(). Is irrelevant if no domain is displayed.

Returns:

instance of UrlBuilder

disableDomain

public UrlBuilder disableDomain()

Don't output domain on toString(). When disabled, protocol will be disabled as well.

Returns:

instance of UrlBuilder

disableEncoding

public UrlBuilder disableEncoding()

Disable default encoding on parameters.

Returns:

instance of UrlBuilder

disableTrailingSlash

public UrlBuilder disableTrailingSlash()

If url ends with a path instead of page by default a / will be added. Use this method to disable that trailing slash

Returns:

instance of UrlBuilder

setAnchor

public UrlBuilder setAnchor(java.lang.String anchor)

Add an anchor to url.

Parameters:

anchor - the anchor string to use (excluding the dash)

Returns:

instance of UrlBuilder

addPath

public UrlBuilder addPath(java.lang.String... paths)

Add one or more path segments to url.

Parameters:

paths - One or more path segments

Returns:

instance of UrlBuilder

addPage

public UrlBuilder addPage(java.lang.String page)

Add page (including extension) to path

Parameters:

page - complete page name ie: page.html

Returns:

instance of UrlBuilder

addParamsFromURL

public UrlBuilder addParamsFromURL(java.lang.String url,
                                   java.lang.String... ignoreKeys)

Extract parameters from existing url and add them.

Parameters:

url - The url to extract params from

ignoreKeys - One or more param keys to ignore

Returns:

instance of UrlBuilder

addParam

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

Add number parameter to url

Parameters:

key - The key of the parameter

value - The value of the parameter

Returns:

instance of UrlBuilder

addParam

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

Add parameter with one or more values

Parameters:

key - The key of the parameter

values - One or more value(s) of the parameter

Returns:

instance of UrlBuilder

overrideParam

public UrlBuilder overrideParam(java.lang.String key,
                                long value)

Parameters:

key - The key of the parameter

value - The value of the parameter

Returns:

instance of UrlBuilder

overrideParam

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

Parameters:

key - The key of the parameter

values - One or more value(s) of the parameter

Returns:

instance of UrlBuilder

hasParam

public boolean hasParam(java.lang.String key)

Parameters:

key - The key of the parameter

Returns:

instance of UrlBuilder

removeParam

public UrlBuilder removeParam(java.lang.String key)

Parameters:

key - The key of the parameter

Returns:

instance of UrlBuilder

removeParamDefault

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

Remove the value of a (multiple) parameter if present

Parameters:

key - The key of the parameter

value - The value to remove if present

Returns:

instance of UrlBuilder

removeParamValuesStartWith

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

Remove value(s) that start with a given string of a (multiple) parameter if present

Parameters:

key - The key of the parameter

value - The value to remove if present

Returns:

instance of UrlBuilder

setDomain

public UrlBuilder setDomain(java.lang.String newDomain)

Set the domain of the url

Parameters:

newDomain - The domain to set.

Returns:

instance of UrlBuilder

toCanonicalUrl

public java.lang.String toCanonicalUrl()
                                throws InvalidUrlException

Generates the canonical url.

Returns:

The canonical url as string

Throws:

InvalidUrlException - When no domain is preset.

toString

public java.lang.String toString()

Generates the url.

Overrides:

toString in class java.lang.Object

Returns:

The complete url as a string