ModelElement (canon-parser 0.0.19 API)

java.lang.Object
- org.symphonyoss.s2.canon.model.ModelElement

Direct Known Subclasses:

AbstractParameter, AbstractPayload, AbstractSchema, Components, EnumSchema, Model, ParameterContainer, ParameterSets, Paths, Reference, Schemas, Version
```
public class ModelElement
extends Object
```

Constructor Summary

Constructors
Constructor and Description
`ModelElement(ModelElement parent, ParserContext parserContext, String type)`
`ModelElement(ModelElement parent, ParserContext parserContext, String type, String name)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(ModelElement e)`
`protected void`	`add(String name, ModelElement element)`
`static String`	`capitalize(String name)`
`void`	`generate(GenerationContext generationContext, Map<String,Object> dataModel)`
`protected void`	`generateChildren(GenerationContext generationContext, Map<String,Object> dataModel)`
`Map<String,String>`	`getAttributes()`
`ModelElement`	`getBaseSchema()` Get the basic schema which this type refers to.
`ModelElement`	`getByPath(String[] pathNames, int index)`
`String`	`getCamelCapitalizedName()`
`String`	`getCamelName()`
`boolean`	`getCanFailValidation()`
`List<ModelElement>`	`getChildren()`
`ModelElement`	`getComponent()`
`ParserContext`	`getContext()`
`String`	`getDescription()`
`ModelElement`	`getElementComponent()`
`ModelElement`	`getElementSchema()` For an array type this is the schema of a single element of the array.
`String`	`getElementType()`
`EnumSchema`	`getEnum()`
`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.
`String`	`getFormat()`
`boolean`	`getHasByteString()`
`boolean`	`getHasCollections()`
`boolean`	`getHasList()`
`boolean`	`getHasSet()`
`boolean`	`getIsArraySchema()`
`boolean`	`getIsComponent()`
`boolean`	`getIsGenerateBuilderFacade()`
`boolean`	`getIsGenerateFacade()`
`boolean`	`getIsObjectSchema()`
`boolean`	`getIsObjectType()`
`boolean`	`getIsTypeDef()`
`Model`	`getModel()`
`String`	`getName()`
`ModelElement`	`getParent()`
`ModelElement`	`getReference()`
`Set<AbstractSchema>`	`getReferencedTypes()`
`protected void`	`getReferencedTypes(Set<AbstractSchema> result)`
`Set<AbstractSchema>`	`getSchemas()`
`protected void`	`getSchemas(Set<AbstractSchema> result)`
`String`	`getSnakeCapitalizedName()`
`String`	`getSnakeName()`
`String`	`getSummary()`
`void`	`resolve()`
`String`	`toString()`
`void`	`validate()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ModelElement

public ModelElement(ModelElement parent,
                    ParserContext parserContext,
                    String type)

ModelElement

public ModelElement(ModelElement parent,
                    ParserContext parserContext,
                    String type,
                    String name)

Method Detail

getBaseSchema
```
public ModelElement getBaseSchema()
```
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

Returns:

The base schema which this type refers to.

getComponent
```
public ModelElement getComponent()
```

getElementSchema
```
public ModelElement getElementSchema()
```
For an array type this is the schema of a single element of the array.

Returns:

The schema of a single element of an array

getElementComponent

public ModelElement getElementComponent()

getIsArraySchema
```
public boolean getIsArraySchema()
```

getIsObjectSchema
```
public boolean getIsObjectSchema()
```

getAttributes

public Map<String,String> getAttributes()

capitalize

public static String capitalize(String name)

getModel
```
public Model getModel()
```

getName
```
public String getName()
```

getCamelName
```
public String getCamelName()
```

getCamelCapitalizedName

public String getCamelCapitalizedName()

getSnakeName
```
public String getSnakeName()
```

getSnakeCapitalizedName

public String getSnakeCapitalizedName()

getSummary
```
public String getSummary()
```

getDescription
```
public String getDescription()
```

getFormat
```
public String getFormat()
```

getHasSet
```
public boolean getHasSet()
```

getHasList
```
public boolean getHasList()
```

getHasCollections
```
public boolean getHasCollections()
```

getHasByteString
```
public boolean getHasByteString()
```

getIsComponent
```
public boolean getIsComponent()
```

getIsTypeDef
```
public boolean getIsTypeDef()
```

getIsObjectType
```
public boolean getIsObjectType()
```

getIsGenerateFacade
```
public boolean getIsGenerateFacade()
```

getIsGenerateBuilderFacade

public boolean getIsGenerateBuilderFacade()

getReference
```
public ModelElement getReference()
```

getEnum
```
public EnumSchema getEnum()
```

getReferencedTypes

public Set<AbstractSchema> getReferencedTypes()

getReferencedTypes

protected void getReferencedTypes(Set<AbstractSchema> result)

getSchemas

public Set<AbstractSchema> getSchemas()

getSchemas

protected void getSchemas(Set<AbstractSchema> result)

resolve
```
public void resolve()
```

validate
```
public void validate()
```

add
```
public void add(ModelElement e)
```

getParent
```
public ModelElement getParent()
```

getContext
```
public ParserContext getContext()
```

getElementType
```
public String getElementType()
```

getChildren

public List<ModelElement> getChildren()

getFields
```
public 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.

Returns:

The fields of this object.

generate

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

Throws:: GenerationException

generateChildren

protected void generateChildren(GenerationContext generationContext,
                                Map<String,Object> dataModel)
                         throws GenerationException

Throws:: GenerationException

add

protected void add(String name,
                   ModelElement element)

getByPath

public ModelElement getByPath(String[] pathNames,
                              int index)

getCanFailValidation
```
public boolean getCanFailValidation()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

Class ModelElement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ModelElement

ModelElement

Method Detail

getBaseSchema

getComponent

getElementSchema

getElementComponent

getIsArraySchema

getIsObjectSchema

getAttributes

capitalize

getModel

getName

getCamelName

getCamelCapitalizedName

getSnakeName

getSnakeCapitalizedName

getSummary

getDescription

getFormat

getHasSet

getHasList

getHasCollections

getHasByteString

getIsComponent

getIsTypeDef

getIsObjectType

getIsGenerateFacade

getIsGenerateBuilderFacade

getReference

getEnum

getReferencedTypes

getReferencedTypes

getSchemas

getSchemas

resolve

validate

add

getParent

getContext

getElementType

getChildren

getFields

generate

generateChildren

add

getByPath

getCanFailValidation

toString