Package com.mastfrog.url

Class URLBuilder

java.lang.Object

com.mastfrog.util.builder.AbstractBuilder<PathElement,URL>

com.mastfrog.url.URLBuilder

All Implemented Interfaces:

Builder<PathElement,URL,AbstractBuilder<PathElement,URL>>

public final class URLBuilder
extends AbstractBuilder<PathElement,URL>

Factory class for constructing URL objects w/ validation.

Author:

Tim Boudreau

Field Summary

Fields inherited from class com.mastfrog.util.builder.AbstractBuilder

elements

Constructor Summary

Constructors

Constructor	Description
URLBuilder()
URLBuilder(Protocol protocol)
URLBuilder(URL prototype)

Method Summary

Modifier and Type	Method	Description
URLBuilder	add(PathElement element)	Add an element
URLBuilder	addDomain(Label domain)
URLBuilder	addDomain(String domain)
protected URLBuilder	addElement(PathElement element)
URLBuilder	addPathElement(PathElement element)
URLBuilder	addPathElement(String element)
URLBuilder	addQueryPair(ParametersElement element)
URLBuilder	addQueryPair(String key, String value)
URLBuilder	addQueryPairIfNotNullOrEmpty(String key, String value)
URLBuilder	addQueryPairs(Map<String,Object> pairs, Function<Object,String> toString)
URLBuilder	addQueryPairs(Map<String,String> pairs)
URL	create()	Create an object.
protected PathElement	createElement(String string)
URLBuilder	setAnchor(Anchor anchor)
URLBuilder	setAnchor(String anchor)
URLBuilder	setHost(Host host)
URLBuilder	setHost(String host)
URLBuilder	setPassword(String password)
URLBuilder	setPath(Path path)
URLBuilder	setPath(String path)
URLBuilder	setPort(int port)
URLBuilder	setProtocol(Protocol protocol)
URLBuilder	setProtocol(String protocol)
URLBuilder	setQuery(Parameters query)
URLBuilder	setQueryDelimiter(ParametersDelimiter delimiter)
URLBuilder	setUserName(String userName)
String	toString()

Methods inherited from class com.mastfrog.util.builder.AbstractBuilder

add, elements, onAfterAdd, onBeforeAdd, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mastfrog.util.builder.Builder

build

Constructor Details

URLBuilder

public URLBuilder(Protocol protocol)

URLBuilder

public URLBuilder()

URLBuilder

public URLBuilder(URL prototype)

Method Details

addPathElement

public URLBuilder addPathElement(PathElement element)

addPathElement

public URLBuilder addPathElement(String element)

addDomain

public URLBuilder addDomain(Label domain)

addDomain

public URLBuilder addDomain(String domain)

addQueryPairIfNotNullOrEmpty

public URLBuilder addQueryPairIfNotNullOrEmpty(String key,
 String value)

addQueryPair

public URLBuilder addQueryPair(String key,
 String value)

addQueryPairs

public URLBuilder addQueryPairs(Map<String,Object> pairs,
 Function<Object,String> toString)

addQueryPairs

public URLBuilder addQueryPairs(Map<String,String> pairs)

addQueryPair

public URLBuilder addQueryPair(ParametersElement element)

setQueryDelimiter

public URLBuilder setQueryDelimiter(ParametersDelimiter delimiter)

setProtocol

public URLBuilder setProtocol(String protocol)

setProtocol

public URLBuilder setProtocol(Protocol protocol)

setAnchor

public URLBuilder setAnchor(Anchor anchor)

setAnchor

public URLBuilder setAnchor(String anchor)

setHost

public URLBuilder setHost(Host host)

setPassword

public URLBuilder setPassword(String password)

setPath

public URLBuilder setPath(Path path)

setPath

public URLBuilder setPath(String path)

setPort

public URLBuilder setPort(int port)

setQuery

public URLBuilder setQuery(Parameters query)

setUserName

public URLBuilder setUserName(String userName)

setHost

public URLBuilder setHost(String host)

add

public URLBuilder add(PathElement element)

Description copied from interface: Builder

Add an element

May throw an exception if called after create() has been called.

Specified by:

add in interface Builder<PathElement,URL,AbstractBuilder<PathElement,URL>>

Overrides:

add in class AbstractBuilder<PathElement,URL>

Parameters:

element - The element

Returns:

this, or a new builder (callers should not assume all implementations return this)

addElement

protected URLBuilder addElement(PathElement element)

Overrides:

addElement in class AbstractBuilder<PathElement,URL>

toString

public String toString()

Overrides:

toString in class Object

create

public URL create()

Description copied from interface: Builder

Create an object. A Builder should be thrown away after a call to this method, and implementations will typically throw an exception if this is called twice.

Returns:

The object this builder creates, which somehow composes together the elements that were passed to it

createElement

protected PathElement createElement(String string)

Specified by:

createElement in class AbstractBuilder<PathElement,URL>