org.symphonyoss.s2.canon.runtime

Class EntityBuilder<B extends EntityBuilder<B>>

java.lang.Object

org.symphonyoss.s2.canon.runtime.EntityBuilder<B>

Type Parameters:

B - Fluent type, determines the type of the "this" reference returned by with methods.

All Implemented Interfaces:

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

public abstract class EntityBuilder<B extends EntityBuilder<B>>
extends Object
implements IEntityBuilder, 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

Modifier	Constructor and Description
protected	EntityBuilder(Class<B> type)
protected	EntityBuilder(Class<B> type, IBaseEntity other)

Method Summary

Modifier and Type	Method and Description
abstract IEntity	build()
com.google.common.collect.ImmutableSet<String>	getCanonUnknownKeys() The set of keys present in the JSON from which this object was deserialized which are not defined by the schema.
org.symphonyoss.s2.common.dom.json.IImmutableJsonDomNode	getJsonDomNode()
void	getJsonObject(org.symphonyoss.s2.common.dom.json.MutableJsonObject jsonObject) Fill in the JSON representation of the current state of this builder.
protected B	self()
org.symphonyoss.s2.common.immutable.ImmutableByteArray	serialize()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.symphonyoss.s2.canon.runtime.IEntity

getCanonMajorVersion, getCanonMinorVersion, getCanonType, getJsonObject

Field Detail

SERIALIZER

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

Constructor Detail

EntityBuilder

protected EntityBuilder(Class<B> type)

EntityBuilder

protected EntityBuilder(Class<B> type,
                        IBaseEntity other)

Method Detail

self

protected B self()

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

getCanonUnknownKeys

public com.google.common.collect.ImmutableSet<String> getCanonUnknownKeys()

Description copied from interface: IEntity

The set of keys present in the JSON from which this object was deserialized which are not defined by the schema. In the case where an object extends some other object the super-class unknown keys will include all keys defined by the current class.

Specified by:

getCanonUnknownKeys in interface IEntity

Returns:

The set of unknown keys in the JSON from which this object was deserialized;

serialize

public org.symphonyoss.s2.common.immutable.ImmutableByteArray serialize()

Specified by:

serialize in interface IBaseEntity

build

public abstract IEntity build()
                       throws org.symphonyoss.s2.common.exception.InvalidValueException

Throws:

org.symphonyoss.s2.common.exception.InvalidValueException