io.apicurio.datamodels.openapi.v2.models

Class Oas20Definitions

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.openapi.v2.models.Oas20Definitions

All Implemented Interfaces:

IIndexedNode<Oas20SchemaDefinition>, IVisitable

public class Oas20Definitions
extends Node
implements IIndexedNode<Oas20SchemaDefinition>

Models an OpenAPI 2.0 Definitions.

Author:

eric.wittmann@gmail.com

Field Summary

Fields inherited from class io.apicurio.datamodels.core.models.Node

_attributes, _extraProperties, _modelId, _ownerDocument, _parent, _validationProblems

Constructor Summary

Constructors

Constructor and Description
Oas20Definitions() Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(IVisitor visitor) Called to accept a visitor onto a visitable data model instance.
Oas20SchemaDefinition	addDefinition(String name, Oas20SchemaDefinition schema) Adds a definition.
void	addItem(String name, Oas20SchemaDefinition item) Adds a child item.
Oas20SchemaDefinition	createSchemaDefinition(String name) Creates an OAS 2.0 Schema object.
Oas20SchemaDefinition	deleteItem(String name) Deletes a child item by name and returns the deleted child or undefined if there wasn't one.
Oas20SchemaDefinition	getDefinition(String name) Returns a single definition schema by name.
List<String>	getDefinitionNames() Gets a list of all the definition names.
List<Oas20SchemaDefinition>	getDefinitions() Returns an array of all the definitions.
Oas20SchemaDefinition	getItem(String name) Gets a single item (indexed child) by name.
List<String>	getItemNames() Gets a list of the names of all indexed children.
List<Oas20SchemaDefinition>	getItems() Returns an array of all the child items.
Oas20SchemaDefinition	removeDefinition(String name) Removes a definition by name.

Methods inherited from class io.apicurio.datamodels.core.models.Node

addExtraProperty, addValidationProblem, clearAttributes, clearValidationProblems, getAttribute, getAttributeNames, getExtraProperty, getExtraPropertyNames, getValidationProblemCodes, getValidationProblems, getValidationProblemsFor, hasExtraProperties, isExtensible, modelId, ownerDocument, parent, removeExtraProperty, setAttribute

Methods inherited from class java.lang.Object

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

Constructor Detail

Oas20Definitions

public Oas20Definitions()

Constructor.

Method Detail

accept

public void accept(IVisitor visitor)

Description copied from interface: IVisitable

Called to accept a visitor onto a visitable data model instance.

Specified by:

accept in interface IVisitable

Specified by:

accept in class Node

See Also:

Node.accept(io.apicurio.datamodels.core.visitors.IVisitor)

getDefinition

public Oas20SchemaDefinition getDefinition(String name)

Returns a single definition schema by name.

Parameters:

name -

getDefinitions

public List<Oas20SchemaDefinition> getDefinitions()

Returns an array of all the definitions.

addDefinition

public Oas20SchemaDefinition addDefinition(String name,
                                           Oas20SchemaDefinition schema)

Adds a definition.

Parameters:

name -

schema -

removeDefinition

public Oas20SchemaDefinition removeDefinition(String name)

Removes a definition by name.

Parameters:

name -

getDefinitionNames

public List<String> getDefinitionNames()

Gets a list of all the definition names.

createSchemaDefinition

public Oas20SchemaDefinition createSchemaDefinition(String name)

Creates an OAS 2.0 Schema object.

Parameters:

name -

getItem

public Oas20SchemaDefinition getItem(String name)

Description copied from interface: IIndexedNode

Gets a single item (indexed child) by name. Returns undefined if not found.

Specified by:

getItem in interface IIndexedNode<Oas20SchemaDefinition>

See Also:

IIndexedNode.getItem(java.lang.String)

getItems

public List<Oas20SchemaDefinition> getItems()

Description copied from interface: IIndexedNode

Returns an array of all the child items.

Specified by:

getItems in interface IIndexedNode<Oas20SchemaDefinition>

See Also:

IIndexedNode.getItems()

getItemNames

public List<String> getItemNames()

Description copied from interface: IIndexedNode

Gets a list of the names of all indexed children.

Specified by:

getItemNames in interface IIndexedNode<Oas20SchemaDefinition>

See Also:

IIndexedNode.getItemNames()

addItem

public void addItem(String name,
                    Oas20SchemaDefinition item)

Description copied from interface: IIndexedNode

Adds a child item.

Specified by:

addItem in interface IIndexedNode<Oas20SchemaDefinition>

See Also:

IIndexedNode.addItem(java.lang.String, io.apicurio.datamodels.core.models.Node)

deleteItem

public Oas20SchemaDefinition deleteItem(String name)

Description copied from interface: IIndexedNode

Deletes a child item by name and returns the deleted child or undefined if there wasn't one.

Specified by:

deleteItem in interface IIndexedNode<Oas20SchemaDefinition>

See Also:

IIndexedNode.deleteItem(java.lang.String)