siren

Class Entity.Builder

java.lang.Object

siren.Entity.Builder

All Implemented Interfaces:

Builder<Entity>

Enclosing class:

Entity

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

Constructs instances of Entity.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

Method Detail

klass

public Entity.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 Entity.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> Entity.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 Entity.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 Entity.Builder actions(Action... actions)

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

Parameters:

actions - Actions showing available behaviors an entity exposes.

Returns:

The builder this method is called on.

link

public Entity.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 Entity.Builder links(Link... links)

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

Parameters:

links - Navigational links, distinct from entity relationships. 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 Entity.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 Entity.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 Entity.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.

clear

public void clear()

Clears the state of the builder.

Specified by:

clear in interface Builder<Entity>

build

public Entity build()

Constructs an instance with the current state of the builder.

Specified by:

build in interface Builder<Entity>

Returns:

Instance with the current state of the builder.