org.ocpsoft.urlbuilder

Class AddressBuilderScheme

java.lang.Object

org.ocpsoft.urlbuilder.AddressBuilderScheme

public class AddressBuilderScheme
extends Object

An Address with a scheme section.

Author:

Lincoln Baxter, III

Method Summary

Methods

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.
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	pathEncoded(CharSequence path) Set the encoded 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	queryEncoded(CharSequence name, Object... values) Set a pre-encoded query-parameter to a pre-encoded 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.
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()

Generate an Address representing the current state of this AddressBuilder.

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.

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.

pathEncoded

public AddressBuilderPath pathEncoded(CharSequence path)

Set the encoded path section of this Address. The given value will be decoded 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 encoded before they are stored.

queryEncoded

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

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

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