org.symphonyoss.s2.canon.runtime

Class Entity

java.lang.Object

org.symphonyoss.s2.canon.runtime.BaseEntity

org.symphonyoss.s2.canon.runtime.Entity

All Implemented Interfaces:

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

public class Entity
extends BaseEntity
implements IEntity

Base class for all generated object classes in a Canon model.

Author:

Bruce Skingle

Constructor Summary

Constructors

Constructor and Description
Entity(IEntity canonOther) Constructor from another instance, usually a Builder.
Entity(org.symphonyoss.s2.common.dom.json.ImmutableJsonObject jsonObject) Constructor from serialized form.

Method Summary

Modifier and Type	Method and Description
String	getCanonType() Return the type identifier (_type JSON attribute) for this entity.
org.symphonyoss.s2.common.dom.json.ImmutableJsonObject	getJsonObject() Return the JSON object from which this entity was created.

Methods inherited from class org.symphonyoss.s2.canon.runtime.BaseEntity

equals, getJsonDomNode, hashCode, serialize, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getJsonDomNode, serialize

Constructor Detail

Entity

public Entity(org.symphonyoss.s2.common.dom.json.ImmutableJsonObject jsonObject)

Constructor from serialized form.

Parameters:

jsonObject - A parse tree of the serialized form.

Entity

public Entity(IEntity canonOther)

Constructor from another instance, usually a Builder.

Parameters:

canonOther - Another entity containing all values for the required object. This is usually a Builder.

Method Detail

getJsonObject

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

Description copied from interface: IEntity

Return the JSON object from which this entity was created.

Specified by:

getJsonObject in interface IEntity

Returns:

the JSON object from which this entity was created.

getCanonType

@Nonnull
public String getCanonType()

Description copied from interface: IEntity

Return the type identifier (_type JSON attribute) for this entity.

Specified by:

getCanonType in interface IEntity

Returns:

The type identifier for this object.