io.apicurio.datamodels.openapi.v3.models

Class Oas30Callback

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.openapi.v3.models.Oas30Callback

All Implemented Interfaces:

INamed, IIndexedNode<Oas30CallbackPathItem>, IReferenceNode, IVisitable

Direct Known Subclasses:

Oas30CallbackDefinition

public class Oas30Callback
extends ExtensibleNode
implements IIndexedNode<Oas30CallbackPathItem>, INamed, IReferenceNode

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
String	$ref

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

_extensions

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

_attributes, _extraProperties, _modelId, _ownerDocument, _parent, _validationProblems

Constructor Summary

Constructors

Constructor and Description
Oas30Callback(String name) Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(IVisitor visitor) Called to accept a visitor onto a visitable data model instance.
void	addItem(String name, Oas30CallbackPathItem item) Adds a child item.
Oas30CallbackPathItem	addPathItem(String name, Oas30CallbackPathItem pathItem) Adds a path item.
Oas30CallbackPathItem	createPathItem(String path) Creates an OAS path item object.
Oas30CallbackPathItem	deleteItem(String name) Deletes a child item by name and returns the deleted child or undefined if there wasn't one.
Oas30CallbackPathItem	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<Oas30CallbackPathItem>	getItems() Returns an array of all the child items.
String	getName() Gets the definition name.
Oas30CallbackPathItem	getPathItem(String name) Returns a single path item by name.
List<String>	getPathItemNames() Gets a list of all the path names.
List<Oas30CallbackPathItem>	getPathItems() Returns an array of all the path items.
Oas30CallbackPathItem	removePathItem(String path) Removes a single path item child model by name.
void	rename(String newName) Renames the definition.

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

addExtension, clearExtensions, createExtension, getExtension, getExtensions, isExtensible, removeExtension

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

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

Methods inherited from class java.lang.Object

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

Field Detail

$ref

public String $ref

Constructor Detail

Oas30Callback

public Oas30Callback(String name)

Constructor.

Parameters:

name -

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)

getName

public String getName()

Description copied from interface: INamed

Gets the definition name.

Specified by:

getName in interface INamed

See Also:

INamed.getName()

rename

public void rename(String newName)

Description copied from interface: INamed

Renames the definition.

Specified by:

rename in interface INamed

See Also:

INamed.rename(java.lang.String)

getPathItem

public Oas30CallbackPathItem getPathItem(String name)

Returns a single path item by name.

Parameters:

name -

getPathItems

public List<Oas30CallbackPathItem> getPathItems()

Returns an array of all the path items.

addPathItem

public Oas30CallbackPathItem addPathItem(String name,
                                         Oas30CallbackPathItem pathItem)

Adds a path item.

Parameters:

name -

pathItem -

getPathItemNames

public List<String> getPathItemNames()

Gets a list of all the path names.

removePathItem

public Oas30CallbackPathItem removePathItem(String path)

Removes a single path item child model by name.

Parameters:

path -

createPathItem

public Oas30CallbackPathItem createPathItem(String path)

Creates an OAS path item object.

Parameters:

path -

getItem

public Oas30CallbackPathItem 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<Oas30CallbackPathItem>

See Also:

IIndexedNode.getItem(java.lang.String)

getItems

public List<Oas30CallbackPathItem> getItems()

Description copied from interface: IIndexedNode

Returns an array of all the child items.

Specified by:

getItems in interface IIndexedNode<Oas30CallbackPathItem>

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<Oas30CallbackPathItem>

See Also:

IIndexedNode.getItemNames()

addItem

public void addItem(String name,
                    Oas30CallbackPathItem item)

Description copied from interface: IIndexedNode

Adds a child item.

Specified by:

addItem in interface IIndexedNode<Oas30CallbackPathItem>

See Also:

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

deleteItem

public Oas30CallbackPathItem 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<Oas30CallbackPathItem>

See Also:

IIndexedNode.deleteItem(java.lang.String)