org.symphonyoss.s2.canon.model

Class ReferenceSchema

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.ReferenceSchema

public class ReferenceSchema
extends ReferenceOrSchema

A schema defined as { "$ref": "#/some/URI" } In order to allow forward references these objects need to be first created and then resolved in a second pass of the model.

Author:

Bruce Skingle

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Schema	getBaseSchema() Get the basic schema which this type refers to.
String	getCamelCapitalizedName()
String	getCamelName()
boolean	getCanFailValidation()
ModelElement	getComponent()
ModelElement	getElementComponent()
Schema	getElementSchema() For an array type this is the schema of a single element of the array.
EnumSchema	getEnum()
boolean	getHasByteString()
boolean	getHasCollections()
boolean	getHasList()
boolean	getHasSet()
boolean	getIsArraySchema()
boolean	getIsComponent()
boolean	getIsObjectSchema()
boolean	getIsObjectType()
boolean	getIsTypeDef()
String	getName()
Schema	getReference()
protected void	getReferencedTypes(Set<AbstractSchema> result)
String	getSnakeCapitalizedName()
String	getSnakeName()
Schema	getType()
boolean	isResolved()
void	resolve()
String	toString()

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

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

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

add, add, capitalize, generate, getAttributes, getByPath, getChildren, getContext, getDescription, getElementType, getFields, getFormat, getIsGenerateBuilderFacade, getIsGenerateFacade, getModel, getParent, getReferencedTypes, getSchemas, getSchemas, getSummary, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceSchema

public ReferenceSchema(ModelElement parent,
                       ParserContext context,
                       ParserContext node,
                       String name)

Method Detail

resolve

public void resolve()

Overrides:

resolve in class ModelElement

getBaseSchema

public Schema getBaseSchema()

Description copied from class: AbstractSchema

Get the basic schema which this type refers to. For a field it will be the field type, for a reference the referenced type. For a field whose type is a reference then it will be the ultimate referenced type. The baseSchema could be an ArraySchema

Specified by:

getBaseSchema in class AbstractSchema

Returns:

The base schema which this type refers to.

getComponent

public ModelElement getComponent()

Overrides:

getComponent in class ModelElement

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

isResolved

public boolean isResolved()

Overrides:

isResolved in class ReferenceOrSchema

getReference

public Schema getReference()

Overrides:

getReference in class ModelElement

getType

public Schema getType()

getEnum

public EnumSchema getEnum()

Overrides:

getEnum in class ModelElement

getIsTypeDef

public boolean getIsTypeDef()

Overrides:

getIsTypeDef in class ModelElement

getIsComponent

public boolean getIsComponent()

Overrides:

getIsComponent in class ModelElement

getIsObjectType

public boolean getIsObjectType()

Overrides:

getIsObjectType in class ModelElement

getReferencedTypes

protected void getReferencedTypes(Set<AbstractSchema> result)

Overrides:

getReferencedTypes in class ModelElement

getName

public String getName()

Overrides:

getName in class ModelElement

getCamelName

public String getCamelName()

Overrides:

getCamelName in class ModelElement

getCamelCapitalizedName

public String getCamelCapitalizedName()

Overrides:

getCamelCapitalizedName in class ModelElement

getSnakeName

public String getSnakeName()

Overrides:

getSnakeName in class ModelElement

getSnakeCapitalizedName

public String getSnakeCapitalizedName()

Overrides:

getSnakeCapitalizedName in class ModelElement

getCanFailValidation

public boolean getCanFailValidation()

Overrides:

getCanFailValidation in class ModelElement

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

toString

public String toString()

Overrides:

toString in class AbstractSchema