org.symphonyoss.s2.canon.runtime

Class EntityBuilder

java.lang.Object

org.symphonyoss.s2.canon.runtime.EntityBuilder

All Implemented Interfaces:

IBaseEntity, org.symphonyoss.s2.common.dom.json.IJsonDomNodeProvider

public abstract class EntityBuilder
extends Object
implements org.symphonyoss.s2.common.dom.json.IJsonDomNodeProvider, IBaseEntity

A builder for some entity type. Essentially this is a mutable version of the enclosing entity type.

Author:

Bruce Skingle

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.symphonyoss.s2.common.dom.DomSerializer	SERIALIZER

Constructor Summary

Constructors

Constructor and Description
EntityBuilder(EntityFactory<?,?,?> factory) Constructor.

Method Summary

Modifier and Type	Method and Description
org.symphonyoss.s2.common.dom.json.IImmutableJsonDomNode	getJsonDomNode()
abstract org.symphonyoss.s2.common.dom.json.ImmutableJsonObject	getJsonObject() Return the JSON representation of the current state of this builder.
void	getJsonObject(org.symphonyoss.s2.common.dom.json.MutableJsonObject jsonObject) Fill in the JSON representation of the current state of this builder.
String	serialize()
void	validate() Called immediately prior to building an instance from this builder.

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZER

protected static final org.symphonyoss.s2.common.dom.DomSerializer SERIALIZER

Constructor Detail

EntityBuilder

public EntityBuilder(EntityFactory<?,?,?> factory)

Constructor.

Parameters:

factory - The factory with which this builder is associated.

Method Detail

getJsonObject

public abstract org.symphonyoss.s2.common.dom.json.ImmutableJsonObject getJsonObject()

Return the JSON representation of the current state of this builder.

Returns:

the JSON representation of the current state of this builder.

getJsonObject

public void getJsonObject(org.symphonyoss.s2.common.dom.json.MutableJsonObject jsonObject)

Fill in the JSON representation of the current state of this builder. Implementations should call super.getJsonObject(jsonObject);

Parameters:

jsonObject - the JSON representation of the current state of this builder.

getJsonDomNode

public org.symphonyoss.s2.common.dom.json.IImmutableJsonDomNode getJsonDomNode()

Specified by:

getJsonDomNode in interface IBaseEntity

Specified by:

getJsonDomNode in interface org.symphonyoss.s2.common.dom.json.IJsonDomNodeProvider

serialize

public String serialize()

Specified by:

serialize in interface IBaseEntity

validate

public void validate()
              throws org.symphonyoss.s2.common.exception.InvalidValueException

Called immediately prior to building an instance from this builder.

Throws:

org.symphonyoss.s2.common.exception.InvalidValueException - May be thrown if the values in the builder as a whole are not valid.