net.eledge.urlbuilder

Class UrlBuilder

java.lang.Object

net.eledge.urlbuilder.UrlBuilder

public class UrlBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH_SEPERATOR

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
UrlBuilder	addPage(String page)
UrlBuilder	addParam(String key, long value)
UrlBuilder	addParam(String key, String... values)
UrlBuilder	addParamsFromURL(String url, String... ignoreKeys)
UrlBuilder	addPath(String... paths)
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(String key)
UrlBuilder	overrideParam(String key, long value)
UrlBuilder	overrideParam(String key, String... values)
UrlBuilder	removeParam(String key)
UrlBuilder	removeParamDefault(String key, String value)
UrlBuilder	removeParamValuesStartWith(String key, String value)
UrlBuilder	setAnchor(String a)
UrlBuilder	setDomain(String newDomain)
String	toCanonicalUrl()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PATH_SEPERATOR

public static final String PATH_SEPERATOR

See Also:

Constant Field Values

Constructor Detail

UrlBuilder

public UrlBuilder(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(String a)

Parameters:

a -

Returns:

instance of UrlBuilder

addPath

public UrlBuilder addPath(String... paths)

Parameters:

paths -

Returns:

instance of UrlBuilder

addPage

public UrlBuilder addPage(String page)

Parameters:

page -

Returns:

instance of UrlBuilder

addParamsFromURL

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

Parameters:

url -

ignoreKeys -

Returns:

instance of UrlBuilder

addParam

public UrlBuilder addParam(String key,
                  long value)

Parameters:

key -

value -

Returns:

instance of UrlBuilder

overrideParam

public UrlBuilder overrideParam(String key,
                       long value)

Parameters:

key -

value -

override -

Returns:

instance of UrlBuilder

addParam

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

Parameters:

key -

values -

Returns:

instance of UrlBuilder

overrideParam

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

Parameters:

key -

values -

override -

Returns:

instance of UrlBuilder

hasParam

public boolean hasParam(String key)

Parameters:

key -

Returns:

instance of UrlBuilder

removeParam

public UrlBuilder removeParam(String key)

Parameters:

key -

Returns:

instance of UrlBuilder

removeParamDefault

public UrlBuilder removeParamDefault(String key,
                            String value)

Parameters:

key -

value -

Returns:

instance of UrlBuilder

removeParamValuesStartWith

public UrlBuilder removeParamValuesStartWith(String key,
                                    String value)

Parameters:

key -

value -

Returns:

instance of UrlBuilder

setDomain

public UrlBuilder setDomain(String newDomain)

Parameters:

newDomain -

Returns:

instance of UrlBuilder

toCanonicalUrl

public String toCanonicalUrl()
                      throws InvalidUrlException

Returns:

Throws:

InvalidUrlException

toString

public String toString()

Overrides:

toString in class Object