Package org.ocpsoft.urlbuilder

Class AddressBuilder

java.lang.Object

org.ocpsoft.urlbuilder.AddressBuilder

public class AddressBuilder
extends Object

Representation of a uniform resource locator, or web address. Internal state is stored as it is originally provided, and must be encoded or decoded as necessary.

Author:

Lincoln Baxter, III

Field Summary

Fields

Modifier and Type	Field	Description
protected CharSequence	anchor
protected CharSequence	domain
protected Map<CharSequence,org.ocpsoft.urlbuilder.Parameter>	parameters
protected CharSequence	path
protected Integer	port
protected Map<CharSequence,org.ocpsoft.urlbuilder.Parameter>	queries
protected CharSequence	scheme
protected CharSequence	schemeSpecificPart

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AddressBuilder()

Method Summary

Modifier and Type	Method	Description
static AddressBuilderBase	begin()	Create a new AddressBuilder instance.
protected Address	build()	Generate an Address representing the current state of this AddressBuilder.
protected Address	buildLiteral()	Generate an Address representing the current literal state of this AddressBuilder.
static Address	create(String url)	Create a new Address from the given URL.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

scheme

protected volatile CharSequence scheme

schemeSpecificPart

protected volatile CharSequence schemeSpecificPart

domain

protected volatile CharSequence domain

port

protected volatile Integer port

path

protected volatile CharSequence path

parameters

protected Map<CharSequence,org.ocpsoft.urlbuilder.Parameter> parameters

queries

protected Map<CharSequence,org.ocpsoft.urlbuilder.Parameter> queries

anchor

protected CharSequence anchor

Constructor Details

AddressBuilder

protected AddressBuilder()

Method Details

begin

public static AddressBuilderBase begin()

Create a new AddressBuilder instance.

build

protected Address build()

Generate an Address representing the current state of this AddressBuilder.

buildLiteral

protected Address buildLiteral()

Generate an Address representing the current literal state of this AddressBuilder.

(Does not apply parameterization. E.g. The URL `/{foo}` will be treated as literal text, as opposed to calling build(), which would result in `foo` being treated as a parameterized expression)

create

public static Address create(String url)
                      throws IllegalArgumentException

Create a new Address from the given URL. Improperly formatted or encoded URLs are not parse-able and will result in an exception. No builder parameterization is possible using this method.

Throws:

IllegalArgumentException - when the input URL or URL fragment is not valid.

toString

public String toString()

Overrides:

toString in class Object