ccc.api.types
Class Link

java.lang.Object
  ccc.api.types.Link

public class Link
extends java.lang.Object

Helper class for building URIs.

This class implements the URI template specification version 03: http://bitworking.org/projects/URI-Templates/spec/

Author:

Civic Computing Ltd.

Nested Class Summary

static interface

Link.Encoder URI encoder API.

Constructor Summary

Link(java.lang.String uri)
Constructor.

Method Summary

java.lang.String	build(Link.Encoder encoder) Build a URI with no specified parameters.
java.lang.String	build(java.util.Map<java.lang.String,java.lang.String[]> params, Link.Encoder encoder) Build a URI with the specified parameters.
java.lang.String	build(java.lang.String name, java.lang.String value, Link.Encoder encoder) Build a URI with the specified parameter.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Link

public Link(java.lang.String uri)

Constructor.

Parameters:

uri - The URI as a string.

Method Detail

build

public java.lang.String build(java.lang.String name,
                              java.lang.String value,
                              Link.Encoder encoder)

Build a URI with the specified parameter.

Parameters:

name - The parameter name.

value - The parameter value.

encoder - The encoder to use when building a string.

Returns:

The URI, as a string.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

build

public java.lang.String build(Link.Encoder encoder)

Build a URI with no specified parameters.

Parameters:

encoder - The encoder to use when building a string.

Returns:

The URI, as a string.

build

public java.lang.String build(java.util.Map<java.lang.String,java.lang.String[]> params,
                              Link.Encoder encoder)

Build a URI with the specified parameters.

Parameters:

params - The template parameters.

encoder - The encoder to use when building a string.

Returns:

The URI, as a string.