Package 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, IEntityOrBuilder, 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	Description
Entity(IEntity canonOther)	Constructor from another instance, usually a Builder.
Entity(IEntityBuilder canonOther)	Constructor from another instance, usually a Builder.
Entity(org.symphonyoss.s2.common.dom.json.ImmutableJsonObject jsonObject, IModelRegistry modelRegistry)	Constructor from serialized form.

Method Summary

Modifier and Type	Method	Description
Integer	getCanonMajorVersion()
Integer	getCanonMinorVersion()
String	getCanonType()	Return the type identifier (_type JSON attribute) for this entity.
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.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,
              IModelRegistry modelRegistry)

Constructor from serialized form.

Parameters:

jsonObject - A parse tree of the serialized form.

modelRegistry - A model registry to use to deserialize any nested objects.

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.

Entity

public Entity(IEntityBuilder 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: IEntityOrBuilder

Return the JSON object from which this entity was created.

Specified by:

getJsonObject in interface IEntityOrBuilder

Returns:

the JSON object from which this entity was created.

getCanonType

@Nonnull
public String getCanonType()

Description copied from interface: IEntityOrBuilder

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

Specified by:

getCanonType in interface IEntityOrBuilder

Returns:

The type identifier for this object.

getCanonMajorVersion

@Nullable
public Integer getCanonMajorVersion()

Specified by:

getCanonMajorVersion in interface IEntityOrBuilder

Returns:

The major part of the canon schema version defining this object.

getCanonMinorVersion

@Nullable
public Integer getCanonMinorVersion()

Specified by:

getCanonMinorVersion in interface IEntityOrBuilder

Returns:

The minor part of the canon schema version defining this object.

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;