siren

Class EmbeddedLinkSubEntity.Builder

java.lang.Object

siren.EmbeddedLinkSubEntity.Builder

All Implemented Interfaces:

Builder<EmbeddedLinkSubEntity>

Enclosing class:

EmbeddedLinkSubEntity

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

Constructs an instance of EmbeddedLinkSubEntity.Builder.

Constructor Summary

Constructors

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

Method Summary

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

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 EmbeddedLinkSubEntity.Builder.

Method Detail

klass

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

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

Parameters:

klass - Describes the nature of an entity's content based on the current representation. Possible values are implementation-dependent and should be documented.

Returns:

The builder this method is called on.

klasses

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

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

Parameters:

klasses - Descriptions of the nature of an entity's content based on the current representation. Possible values are implementation-dependent and should be documented.

Returns:

The builder this method is called on.

title

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

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

Parameters:

title - Descriptive text about the entity.

Returns:

The builder this method is called on.

rel

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

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

Parameters:

rel - The relationship of the sub-entity to its parent, per Web Linking (RFC5899).

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.

rel

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

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

Parameters:

rel - The relationship of the sub-entity to its parent, per Web Linking (RFC5899).

Returns:

The builder this method is called on.

See Also:

RFC5899

rel

public EmbeddedLinkSubEntity.Builder rel(Relation rel)

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

Parameters:

rel - The relationship of the sub-entity to its parent, per Web Linking (RFC5899).

Returns:

The builder this method is called on.

See Also:

RFC5899

rels

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

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

Parameters:

rels - The relationships of the sub-entity to its parent, per Web Linking (RFC5899).

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:

RFC5899

rels

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

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

Parameters:

rels - The relationships of the sub-entity to its parent, per Web Linking (RFC5899).

Returns:

The builder this method is called on.

See Also:

RFC5899

rels

public EmbeddedLinkSubEntity.Builder rels(Relation... rels)

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

Parameters:

rels - The relationships of the sub-entity to its parent, per Web Linking (RFC5899).

Returns:

The builder this method is called on.

See Also:

RFC5899

type

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

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

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.

href

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

Adds the href to the current state of the builder.

Parameters:

href - The URI of the linked sub-entity.

Returns:

The builder this method is called on.

clear

public void clear()

Clears the state of the builder.

Specified by:

clear in interface Builder<EmbeddedLinkSubEntity>

build

public EmbeddedLinkSubEntity build()

Constructs an instance of EmbeddedLinkSubEntity with the current state of the builder.

Specified by:

build in interface Builder<EmbeddedLinkSubEntity>

Returns:

Instance of EmbeddedLinkSubEntity with the current state of the builder.