org.symphonyoss.s2.canon.model

Class ObjectSchema

java.lang.Object

org.symphonyoss.s2.canon.model.ModelElement

org.symphonyoss.s2.canon.model.AbstractSchema

org.symphonyoss.s2.canon.model.ReferenceOrSchema

org.symphonyoss.s2.canon.model.Schema

org.symphonyoss.s2.canon.model.ObjectSchema

public class ObjectSchema
extends Schema

Schema for an object.

Author:

Bruce Skingle

Constructor Summary

Constructors

Constructor and Description
ObjectSchema(ModelElement parent, ParserContext context, String name)

Method Summary

Modifier and Type	Method and Description
void	generate(GenerationContext generationContext, Map<String,Object> dataModel)
boolean	getCanFailValidation()
ModelElement	getElementComponent()
Schema	getElementSchema() For an array type this is the schema of a single element of the array.
List<ModelElement>	getFields() Return the fields of this object, for a normal object this is the same as getChildren() for an AllOf it is something else.
boolean	getHasByteString()
boolean	getHasCollections()
boolean	getHasList()
boolean	getHasSet()
boolean	getIsArraySchema()
boolean	getIsGenerateBuilderFacade()
boolean	getIsGenerateFacade()
boolean	getIsObjectSchema()
boolean	getIsObjectType()
protected void	getReferencedTypes(Set<AbstractSchema> result)
protected void	getSchemas(Set<AbstractSchema> result)
ReferenceSchema	getSuperSchema()
void	validate()

Methods inherited from class org.symphonyoss.s2.canon.model.Schema

getBaseSchema, getComponent, getSuperClasses

Methods inherited from class org.symphonyoss.s2.canon.model.ReferenceOrSchema

isResolved

Methods inherited from class org.symphonyoss.s2.canon.model.AbstractSchema

createSchema, generateChildren, getIsAnonymousInnerClass, isRequired, toString, toString, toString, toString

Methods inherited from class org.symphonyoss.s2.canon.model.ModelElement

add, add, capitalize, getAttributes, getByPath, getCamelCapitalizedName, getCamelName, getChildren, getContext, getDescription, getElementType, getEnum, getFormat, getIsComponent, getIsTypeDef, getModel, getName, getParent, getReference, getReferencedTypes, getSchemas, getSnakeCapitalizedName, getSnakeName, getSummary, resolve

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectSchema

public ObjectSchema(ModelElement parent,
                    ParserContext context,
                    String name)

Method Detail

validate

public void validate()

Overrides:

validate in class ModelElement

getSuperSchema

public ReferenceSchema getSuperSchema()

Returns:

The super schema if any.

getFields

public List<ModelElement> getFields()

Description copied from class: ModelElement

Return the fields of this object, for a normal object this is the same as getChildren() for an AllOf it is something else.

Overrides:

getFields in class ModelElement

Returns:

The fields of this object.

getElementSchema

public Schema getElementSchema()

Description copied from class: AbstractSchema

For an array type this is the schema of a single element of the array.

Specified by:

getElementSchema in class AbstractSchema

Returns:

The schema of a single element of an array

getElementComponent

public ModelElement getElementComponent()

Overrides:

getElementComponent in class ModelElement

getIsArraySchema

public boolean getIsArraySchema()

Specified by:

getIsArraySchema in class AbstractSchema

getIsObjectSchema

public boolean getIsObjectSchema()

Specified by:

getIsObjectSchema in class AbstractSchema

getHasSet

public boolean getHasSet()

Overrides:

getHasSet in class ModelElement

getHasList

public boolean getHasList()

Overrides:

getHasList in class ModelElement

getHasCollections

public boolean getHasCollections()

Overrides:

getHasCollections in class ModelElement

getHasByteString

public boolean getHasByteString()

Overrides:

getHasByteString in class ModelElement

getIsObjectType

public boolean getIsObjectType()

Overrides:

getIsObjectType in class ModelElement

getIsGenerateFacade

public boolean getIsGenerateFacade()

Overrides:

getIsGenerateFacade in class ModelElement

getIsGenerateBuilderFacade

public boolean getIsGenerateBuilderFacade()

Overrides:

getIsGenerateBuilderFacade in class ModelElement

getCanFailValidation

public boolean getCanFailValidation()

Overrides:

getCanFailValidation in class ModelElement

getReferencedTypes

protected void getReferencedTypes(Set<AbstractSchema> result)

Overrides:

getReferencedTypes in class ModelElement

getSchemas

protected void getSchemas(Set<AbstractSchema> result)

Overrides:

getSchemas in class ModelElement

generate

public void generate(GenerationContext generationContext,
                     Map<String,Object> dataModel)
              throws GenerationException

Overrides:

generate in class ModelElement

Throws:

GenerationException