net.eusashead.parquet.entity

Interface EntityBuilder

All Superinterfaces:

MutableEntity

All Known Implementing Classes:

BasicEntityBuilder

public interface EntityBuilder
extends MutableEntity

Method Summary

Methods

Modifier and Type	Method and Description
EntityBuilder	append(Entity entity)
<T> EntityBuilder	append(T target, EntityConverter<T> converter)
Entity	build() Complete the Entity under construction
EntityBuilder	embed(java.lang.String rel, Entity entity) Embed an existing Entity with the specified rel
<T> EntityBuilder	embed(java.lang.String rel, T target, EntityConverter<T> converter) Convert the supplied target object to an Entity using the supplied EntityConverter
boolean	empty() Has the EntityBuilder been modified
EntityFactory	entityFactory() Get the EntityFactory for this EntityBuilder
<T> EntityBuilder	forEach(java.lang.String rel, java.lang.Iterable<T> target, EntityConverter<T> converter) Add a collection of Entity converted from the supplied Iterable using the EntityConverter
EntityBuilder	link(Link link) Add a link with the supplied name and href
EntityBuilder	property(java.lang.String name, java.lang.Object value) Embed the supplied value as a property under the supplied name
EntityBuilder	property(java.lang.String name, java.lang.Object value, PropertyConverter<?,java.lang.Object> converter) Embed the supplied String value as a property under the supplied name after converting it to an Object

Method Detail

property

EntityBuilder property(java.lang.String name,
                     java.lang.Object value)

Description copied from interface: MutableEntity

Embed the supplied value as a property under the supplied name

Specified by:

property in interface MutableEntity

Parameters:

name - String name of property

value - Object value of property

Returns:

the current EntityBuilder

property

EntityBuilder property(java.lang.String name,
                     java.lang.Object value,
                     PropertyConverter<?,java.lang.Object> converter)

Description copied from interface: MutableEntity

Embed the supplied String value as a property under the supplied name after converting it to an Object

Specified by:

property in interface MutableEntity

Parameters:

name - String property name

value - Object property value

converter - PropertyConverter to convert to object

Returns:

the current EntityBuilder

embed

EntityBuilder embed(java.lang.String rel,
                  Entity entity)

Description copied from interface: MutableEntity

Embed an existing Entity with the specified rel

Specified by:

embed in interface MutableEntity

Parameters:

rel - String name of the related Entity

entity - Entity to embed

Returns:

the current EntityBuilder

embed

<T> EntityBuilder embed(java.lang.String rel,
                      T target,
                      EntityConverter<T> converter)

Description copied from interface: MutableEntity

Convert the supplied target object to an Entity using the supplied EntityConverter

Specified by:

embed in interface MutableEntity

Parameters:

rel - String name of the related Entity

target - Object to convert to Entity

converter - EntityConverter to perform conversion

Returns:

the current EntityBuilder

forEach

<T> EntityBuilder forEach(java.lang.String rel,
                        java.lang.Iterable<T> target,
                        EntityConverter<T> converter)

Description copied from interface: MutableEntity

Add a collection of Entity converted from the supplied Iterable using the EntityConverter

Specified by:

forEach in interface MutableEntity

Parameters:

rel - String name of the related Entity

target - Iterable to convert

converter - EntityConverter to use

Returns:

the current EntityBuilder

link

EntityBuilder link(Link link)

Description copied from interface: MutableEntity

Add a link with the supplied name and href

Specified by:

link in interface MutableEntity

Parameters:

link - Link to set

Returns:

append

EntityBuilder append(Entity entity)

append

<T> EntityBuilder append(T target,
                       EntityConverter<T> converter)

build

Entity build()

Complete the Entity under construction

Returns:

the constructed Entity

entityFactory

EntityFactory entityFactory()

Get the EntityFactory for this EntityBuilder

Returns:

EntityFactory that constructed this EntityBuilder

empty

boolean empty()

Has the EntityBuilder been modified

Returns: