siren

Class Link.Builder

java.lang.Object

siren.Link.Builder

All Implemented Interfaces:

Builder<Link>

Enclosing class:

Link

public static class Link.Builder
extends java.lang.Object
implements Builder<Link>

Constructs instances of Link.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructs an instance of Link.Builder.

Method Summary

Modifier and Type	Method and Description
Link	build() Constructs a Link instance with the current state of the builder.
void	clear() Clears the state of the builder.
Link.Builder	href(java.net.URI href) Sets the current state of the builder to have the href provided.
Link.Builder	klass(java.lang.String klass) Adds the class provided to the current state of the builder.
Link.Builder	klasses(java.lang.String... klasses) Adds the classes provided to the current state of the builder.
Link.Builder	rel(Relation rel) Adds the relation provided to the current state of the builder.
Link.Builder	rel(java.lang.String rel) Adds the relation provided to the current state of the builder.
Link.Builder	rel(java.net.URI rel) Adds the relation provided to the current state of the builder.
Link.Builder	rels(Relation... rels) Adds the relations provided to the current state of the builder.
Link.Builder	rels(java.lang.String... rels) Adds the relations provided to the current state of the builder.
Link.Builder	rels(java.net.URI... rels) Adds the relations provided to the current state of the builder.
Link.Builder	title(java.lang.String title) Sets current state of the builder to have the title provided.
Link.Builder	type(java.lang.String type) Sets the current state of the builder to have the type provided.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Constructs an instance of Link.Builder.

Method Detail

rel

public Link.Builder rel(java.lang.String rel)
                 throws java.net.URISyntaxException

Adds the relation provided to the current state of the builder.

Parameters:

rel - Defines the relationship of the link to its entity, per Web Linking (RFC5988) and Link Relations.

Returns:

The builder this method is called on.

Throws:

java.net.URISyntaxException - Thrown if the textual representation of the relation is not a registered relation, and is not a valid URI. All extension relations must be in the form of a URI.

See Also:

RFC5988, Link Relations

rel

public Link.Builder rel(java.net.URI rel)

Adds the relation provided to the current state of the builder.

Parameters:

rel - Defines the relationship of the link to its entity, per Web Linking (RFC5988) and Link Relations.

Returns:

The builder this method is called on.

See Also:

RFC5988, Link Relations

rel

public Link.Builder rel(Relation rel)

Adds the relation provided to the current state of the builder.

Parameters:

rel - Defines the relationship of the link to its entity, per Web Linking (RFC5988) and Link Relations

Returns:

The builder this method is called on.

See Also:

RFC5988, Link Relations

rels

public Link.Builder rels(java.lang.String... rels)
                  throws java.net.URISyntaxException

Adds the relations provided to the current state of the builder.

Parameters:

rels - Defines the relationships of the link to its entity, per Web Linking (RFC5988) and Link Relations.

Returns:

The builder this method is called on.

Throws:

java.net.URISyntaxException - Thrown if the textual representation of the relation is not a registered relation, and is not a valid URI. All extension relations must be in the form of a URI.

See Also:

RFC5988, Link Relations

rels

public Link.Builder rels(java.net.URI... rels)

Adds the relations provided to the current state of the builder.

Parameters:

rels - Defines the relationships of the link to its entity, per Web Linking (RFC5988) and Link Relations.

Returns:

The builder this method is called on.

See Also:

RFC5988, Link Relations

rels

public Link.Builder rels(Relation... rels)

Adds the relations provided to the current state of the builder.

Parameters:

rels - Defines the relationships of the link to its entity, per Web Linking (RFC5988) and Link Relations.

Returns:

The builder this method is called on.

See Also:

RFC5988, Link Relations

href

public Link.Builder href(java.net.URI href)

Sets the current state of the builder to have the href provided.

Parameters:

href - The URI of the linked resource.

Returns:

The builder this method is called on.

klass

public Link.Builder klass(java.lang.String klass)

Adds the class provided to the current state of the builder.

Parameters:

klass - Describes aspects of the link based on the current representation. Possible values are implementation-dependent and should be documented.

Returns:

The builder this method is called on.

klasses

public Link.Builder klasses(java.lang.String... klasses)

Adds the classes provided to the current state of the builder.

Parameters:

klasses - Describes aspects of the link based on the current representation. Possible values are implementation-dependent and should be documented.

Returns:

The builder this method is called on.

title

public Link.Builder title(java.lang.String title)

Sets current state of the builder to have the title provided.

Parameters:

title - Text describing the nature of a link.

Returns:

The builder this method is called on.

type

public Link.Builder type(java.lang.String type)

Sets the current state of the builder to have the type provided.

Parameters:

type - Defines media type of the linked resource, per Web Linking (RFC5988). For the syntax, see RFC2045 (section 5.1), RFC4288 (section 4.2), RFC6838 (section 4.2)

Returns:

The builder this method is called on.

See Also:

RFC5988, RFC2045, RFC4288, RFC6838

clear

public void clear()

Clears the state of the builder.

Specified by:

clear in interface Builder<Link>

build

public Link build()

Constructs a Link instance with the current state of the builder.

Specified by:

build in interface Builder<Link>

Returns:

Instance of Link with the current state of the builder.