org.symphonyoss.s2.canon.model

Class Field

java.lang.Object

org.symphonyoss.s2.canon.model.ModelElement

org.symphonyoss.s2.canon.model.AbstractSchema

org.symphonyoss.s2.canon.model.Field

public class Field
extends AbstractSchema

Constructor Summary

Constructors

Constructor and Description
Field(ModelElement parent, ParserContext context, AbstractSchema type, boolean required, String name)

Method Summary

Modifier and Type	Method and Description
static AbstractSchema	create(ModelElement parent, ParserContext context, boolean required)
Schema	getBaseSchema() Get the basic schema which this type refers to.
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	getHasList()
boolean	getHasSet()
boolean	getIsArraySchema()
boolean	getIsComponent()
boolean	getIsObjectSchema()
boolean	getIsObjectType()
boolean	getIsTypeDef()
AbstractSchema	getType()
boolean	isRequired()
String	toString()
void	validate()

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

createSchema, generateChildren, getIsAnonymousInnerClass, toString, toString, toString

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

add, add, capitalize, generate, getAttributes, getByPath, getCamelCapitalizedName, getCamelName, getChildren, getContext, getDescription, getElementType, getFields, getFormat, getHasCollections, getIsGenerateBuilderFacade, getIsGenerateFacade, getModel, getName, getParent, getReference, getReferencedTypes, getReferencedTypes, getSchemas, getSchemas, getSnakeCapitalizedName, getSnakeName, getSummary, resolve

Methods inherited from class java.lang.Object

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

Constructor Detail

Field

public Field(ModelElement parent,
             ParserContext context,
             AbstractSchema type,
             boolean required,
             String name)

Method Detail

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

isRequired

public boolean isRequired()

Overrides:

isRequired in class AbstractSchema

getType

public AbstractSchema getType()

getEnum

public EnumSchema getEnum()

Overrides:

getEnum in class ModelElement

getHasSet

public boolean getHasSet()

Overrides:

getHasSet in class ModelElement

getHasList

public boolean getHasList()

Overrides:

getHasList in class ModelElement

getHasByteString

public boolean getHasByteString()

Overrides:

getHasByteString 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

getCanFailValidation

public boolean getCanFailValidation()

Overrides:

getCanFailValidation in class ModelElement

validate

public void validate()

Overrides:

validate in class ModelElement

create

public static AbstractSchema create(ModelElement parent,
                                    ParserContext context,
                                    boolean required)

toString

public String toString()

Overrides:

toString in class AbstractSchema