org.ocpsoft.urlbuilder

Class AddressBuilderQuery

java.lang.Object

org.ocpsoft.urlbuilder.AddressBuilderQuery

All Implemented Interfaces:

BuildableAddress

public class AddressBuilderQuery
extends Object
implements BuildableAddress

An Address with a query section.

Author:

Lincoln Baxter, III

Method Summary

Modifier and Type	Method and Description
AddressBuilderAnchor	anchor(CharSequence 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.
AddressBuilderQuery	query(CharSequence name, Object value) 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 value) Set a query-parameter to a value or multiple 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

query

public AddressBuilderQuery query(CharSequence name,
                                 Object value)

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 value)

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

anchor

public AddressBuilderAnchor anchor(CharSequence anchor)

Set the anchor section of this Address.

toString

public String toString()

Overrides:

toString in class Object