siren

Class EmbeddedRepresentationSubEntity.Builder

java.lang.Object

siren.EmbeddedRepresentationSubEntity.Builder

All Implemented Interfaces:

Builder<EmbeddedRepresentationSubEntity>

Enclosing class:

EmbeddedRepresentationSubEntity

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

Constructs an instance of EmbeddedRepresentationSubEntity.Builder.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
EmbeddedRepresentationSubEntity.Builder	action(Action action) Adds the action provided to the current state of the builder.
EmbeddedRepresentationSubEntity.Builder	actions(Action... actions) Adds the actions provided to the current state of the builder.
EmbeddedRepresentationSubEntity	build() Constructs an instance with the current state of the builder.
void	clear() Clears the state of the builder.
EmbeddedRepresentationSubEntity.Builder	klass(java.lang.String klass) Adds the class provided to the current state of the builder.
EmbeddedRepresentationSubEntity.Builder	klasses(java.lang.String... klasses) Adds the classes provided to the current state of the builder.
EmbeddedRepresentationSubEntity.Builder	link(Link link) Adds the link provided to the current state of the builder.
EmbeddedRepresentationSubEntity.Builder	links(Link... links) Adds the links provided to the current state of the builder.
<T> EmbeddedRepresentationSubEntity.Builder	property(java.lang.String propertyKey, T propertyValue) Adds the property provided to the current state of the builder.
EmbeddedRepresentationSubEntity.Builder	rel(Relation rel) Adds the relation provided to the current state of the builder.
EmbeddedRepresentationSubEntity.Builder	rel(java.lang.String rel) Adds the relation provided to the current state of the builder.
EmbeddedRepresentationSubEntity.Builder	rel(java.net.URI rel) Adds the relation provided to the current state of the builder.
EmbeddedRepresentationSubEntity.Builder	rels(Relation... rels) Adds the relations provided to the current state of the builder.
EmbeddedRepresentationSubEntity.Builder	rels(java.lang.String... rels) Adds the relations provided to the current state of the builder.
EmbeddedRepresentationSubEntity.Builder	rels(java.net.URI... rels) Adds the relations provided to the current state of the builder.
EmbeddedRepresentationSubEntity.Builder	subEntities(EntityBase... subEntities) Adds the sub-entities provided to the current state of the builder.
EmbeddedRepresentationSubEntity.Builder	subEntity(EntityBase subEntity) Adds the sub-entity provided to the current state of the builder.
EmbeddedRepresentationSubEntity.Builder	title(java.lang.String title) Adds the title 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 EmbeddedRepresentationSubEntity.Builder.

Method Detail

klass

public EmbeddedRepresentationSubEntity.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 EmbeddedRepresentationSubEntity.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.

property

public <T> EmbeddedRepresentationSubEntity.Builder property(java.lang.String propertyKey,
                                                            T propertyValue)

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

Type Parameters:

T - The type of the value portion of a key-value pair that describes the state of an entity.

Parameters:

propertyKey - The key portion of a key-value pair that describes the state of an entity.

propertyValue - The value portion of a key-value pair that describes the state of an entity.

Returns:

The builder this method is called on.

action

public EmbeddedRepresentationSubEntity.Builder action(Action action)

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

Parameters:

action - An action showing an available behavior an entity exposes.

Returns:

The builder this method is called on.

actions

public EmbeddedRepresentationSubEntity.Builder actions(Action... actions)

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

Parameters:

actions - Actions showing an available behavior an entity exposes.

Returns:

The builder this method is called on.

link

public EmbeddedRepresentationSubEntity.Builder link(Link link)

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

Parameters:

link - A navigational link, distinct from an entity relationship. Link items should contain a `rel` attribute to describe the relationship and an `href` attribute to point to the target URI. Entities should include a link `rel` to `self`.

Returns:

The builder this method is called on.

links

public EmbeddedRepresentationSubEntity.Builder links(Link... links)

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

Parameters:

links - Navigational links, distinct from an entity relationship. Link items should contain a `rel` attribute to describe the relationship and an `href` attribute to point to the target URI. Entities should include a link `rel` to `self`.

Returns:

The builder this method is called on.

subEntity

public EmbeddedRepresentationSubEntity.Builder subEntity(EntityBase subEntity)

Adds the sub-entity provided to the current state of the builder.

Parameters:

subEntity - A sub-entity represented as an embedded link or an embedded entity representation.

Returns:

The builder this method is called on.

subEntities

public EmbeddedRepresentationSubEntity.Builder subEntities(EntityBase... subEntities)

Adds the sub-entities provided to the current state of the builder.

Parameters:

subEntities - Sub-entities represented individually as an embedded link or an embedded entity representation.

Returns:

The builder this method is called on.

title

public EmbeddedRepresentationSubEntity.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 EmbeddedRepresentationSubEntity.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.

See Also:

RFC5899

rel

public EmbeddedRepresentationSubEntity.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 EmbeddedRepresentationSubEntity.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 EmbeddedRepresentationSubEntity.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 EmbeddedRepresentationSubEntity.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 EmbeddedRepresentationSubEntity.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

clear

public void clear()

Clears the state of the builder.

Specified by:

clear in interface Builder<EmbeddedRepresentationSubEntity>

build

public EmbeddedRepresentationSubEntity build()

Constructs an instance with the current state of the builder.

Specified by:

build in interface Builder<EmbeddedRepresentationSubEntity>

Returns:

Instance with the current state of the builder.