io.apicurio.datamodels.openapi.models

Class OasPaths

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.openapi.models.OasPaths

All Implemented Interfaces:

IIndexedNode<OasPathItem>, IVisitable

Direct Known Subclasses:

Oas20Paths, Oas30Paths

public abstract class OasPaths
extends ExtensibleNode
implements IIndexedNode<OasPathItem>

Modles the OpenAPI paths.

Author:

eric.wittmann@gmail.com

Field Summary

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
OasPaths()

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, OasPathItem item) Adds a child item.
OasPathItem	addPathItem(String name, OasPathItem pathItem) Adds a path item.
abstract OasPathItem	createPathItem(String path) Creates an OAS path item object.
OasPathItem	deleteItem(String name) Deletes a child item by name and returns the deleted child or undefined if there wasn't one.
OasPathItem	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<OasPathItem>	getItems() Returns an array of all the child items.
OasPathItem	getPathItem(String name) Returns a single path item by name.
List<String>	getPathItemNames() Gets a list of all the path names.
List<OasPathItem>	getPathItems() Returns an array of all the path items.
OasPathItem	removePathItem(String path) Removes a single path item child model by name.

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

Constructor Detail

OasPaths

public OasPaths()

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)

getPathItem

public OasPathItem getPathItem(String name)

Returns a single path item by name.

Parameters:

name -

getPathItems

public List<OasPathItem> getPathItems()

Returns an array of all the path items.

addPathItem

public OasPathItem addPathItem(String name,
                               OasPathItem pathItem)

Adds a path item.

Parameters:

name -

pathItem -

getPathItemNames

public List<String> getPathItemNames()

Gets a list of all the path names.

removePathItem

public OasPathItem removePathItem(String path)

Removes a single path item child model by name.

Parameters:

path -

createPathItem

public abstract OasPathItem createPathItem(String path)

Creates an OAS path item object.

Parameters:

path -

addItem

public void addItem(String name,
                    OasPathItem item)

Description copied from interface: IIndexedNode

Adds a child item.

Specified by:

addItem in interface IIndexedNode<OasPathItem>

See Also:

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

deleteItem

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

See Also:

IIndexedNode.deleteItem(java.lang.String)

getItem

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

See Also:

IIndexedNode.getItem(java.lang.String)

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

See Also:

IIndexedNode.getItemNames()

getItems

public List<OasPathItem> getItems()

Description copied from interface: IIndexedNode

Returns an array of all the child items.

Specified by:

getItems in interface IIndexedNode<OasPathItem>

See Also:

IIndexedNode.getItems()