org.ocpsoft.urlbuilder

Class AddressBuilderScheme

java.lang.Object

org.ocpsoft.urlbuilder.AddressBuilderScheme

All Implemented Interfaces:

BuildableAddress

public class AddressBuilderScheme
extends Object
implements BuildableAddress

An Address with a scheme section.

Author:

Lincoln Baxter, III

Method Summary

Modifier and Type	Method and Description
AddressBuilderAnchor	anchor(String anchor) Set the anchor section of this Address.
Address	build() Generate an Address representing the current state of this AddressBuilder.
Address	buildLiteral() Generate an Address representing the current literal state of this AddressBuilder.
AddressBuilderDomain	domain(CharSequence host) Set the domain section of this Address.
AddressBuilderPath	path(CharSequence path) Set the non-encoded path section of this Address.
AddressBuilderPath	pathDecoded(CharSequence path) Set the path section of this Address.
AddressBuilderPath	pathEncoded(CharSequence path) Set the path section of this Address.
AddressBuilderPort	port(int port) Set the port section of this Address.
AddressBuilderQuery	query(CharSequence name, Object... values) Set a query-parameter to a value or multiple values.
AddressBuilderQuery	queryDecoded(CharSequence name, Object... values) Set a query-parameter value or multiple values.
AddressBuilderQuery	queryEncoded(CharSequence name, Object... values) Set a query-parameter to a value or multiple values.
AddressBuilderQuery	queryLiteral(String query) Set a literal query string without additional encoding or decoding.
AddressBuilderSchemeSpecificPart	schemeSpecificPart(CharSequence schemeSpecificPart) Set the scheme specific part section of this Address.
AddressBuilderScheme	set(CharSequence name, Object... values) Set a parameter name and value or values.
AddressBuilderScheme	setDecoded(CharSequence name, Object... values) Set a parameter name and value or values.
AddressBuilderScheme	setEncoded(CharSequence name, Object... values) Set a parameter name and value or values.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

build

public Address build()

Description copied from interface: BuildableAddress

Generate an Address representing the current state of this AddressBuilder.

Specified by:

build in interface BuildableAddress

buildLiteral

public Address buildLiteral()

Description copied from interface: BuildableAddress

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 BuildableAddress.build(), which would result in `foo` being treated as a parameterized expression)

Specified by:

buildLiteral in interface BuildableAddress

domain

public AddressBuilderDomain domain(CharSequence host)

Set the domain section of this Address.

schemeSpecificPart

public AddressBuilderSchemeSpecificPart schemeSpecificPart(CharSequence schemeSpecificPart)

Set the scheme specific part section of this Address.

set

public AddressBuilderScheme set(CharSequence name,
                                Object... values)

Set a parameter name and value or values. The supplied values will be stored without additional encoding.

setDecoded

public AddressBuilderScheme setDecoded(CharSequence name,
                                       Object... values)

Set a parameter name and value or values. The values will be decoded before they are stored.

setEncoded

public AddressBuilderScheme setEncoded(CharSequence name,
                                       Object... values)

Set a parameter name and value or values. The values will be encoded before they are stored.

port

public AddressBuilderPort port(int port)

Set the port section of this Address.

path

public AddressBuilderPath path(CharSequence path)

Set the non-encoded path section of this Address. The given value will be stored without additional encoding or decoding.

pathDecoded

public AddressBuilderPath pathDecoded(CharSequence path)

Set the path section of this Address. The given value will be decoded before it is stored.

pathEncoded

public AddressBuilderPath pathEncoded(CharSequence path)

Set the path section of this Address. The given value will be encoded before it is stored.

query

public AddressBuilderQuery query(CharSequence name,
                                 Object... values)

Set a query-parameter to a value or multiple values. The given name and values will be stored without additional encoding or decoding.

queryDecoded

public AddressBuilderQuery queryDecoded(CharSequence name,
                                        Object... values)

Set a query-parameter value or multiple values. The given name and values be decoded before they are stored.

queryEncoded

public AddressBuilderQuery queryEncoded(CharSequence name,
                                        Object... values)

Set a query-parameter to a value or multiple values. The given name and values be encoded before they are stored.

queryLiteral

public AddressBuilderQuery queryLiteral(String query)

Set a literal query string without additional encoding or decoding. A leading '?' character is optional; the builder will add one if necessary.

anchor

public AddressBuilderAnchor anchor(String anchor)

Set the anchor section of this Address.

toString

public String toString()

Overrides:

toString in class Object