io.apicurio.datamodels.openapi.models

Class OasResponses

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.openapi.models.OasResponses

All Implemented Interfaces:

IIndexedNode<OasResponse>, IVisitable

Direct Known Subclasses:

Oas20Responses, Oas30Responses

public abstract class OasResponses
extends ExtensibleNode
implements IIndexedNode<OasResponse>

Models an OpenAPI responses.

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
OasResponse	default_

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

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, OasResponse item) Adds a child item.
OasResponse	addResponse(String statusCode, OasResponse response) Adds a response.
OasResponse	createDefaultResponse() Creates a default OAS response.
abstract OasResponse	createResponse(String statusCode) Creates an OAS Response object.
OasResponse	deleteItem(String name) Deletes a child item by name and returns the deleted child or undefined if there wasn't one.
OasResponse	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<OasResponse>	getItems() Returns an array of all the child items.
OasResponse	getResponse(String statusCode) Returns a single response by status code.
List<OasResponse>	getResponses() Returns an array of all the responses.
List<String>	getResponseStatusCodes() Gets a list of all the response status codes.
OasResponse	removeResponse(String statusCode) Removes a single response child model.

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

default_

public OasResponse default_

Constructor Detail

OasResponses

public OasResponses()

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)

getResponse

public OasResponse getResponse(String statusCode)

Returns a single response by status code.

Parameters:

statusCode -

getResponses

public List<OasResponse> getResponses()

Returns an array of all the responses.

addResponse

public OasResponse addResponse(String statusCode,
                               OasResponse response)

Adds a response.

Parameters:

statusCode -

response -

removeResponse

public OasResponse removeResponse(String statusCode)

Removes a single response child model.

Parameters:

statusCode -

getResponseStatusCodes

public List<String> getResponseStatusCodes()

Gets a list of all the response status codes.

createResponse

public abstract OasResponse createResponse(String statusCode)

Creates an OAS Response object.

Parameters:

statusCode -

createDefaultResponse

public OasResponse createDefaultResponse()

Creates a default OAS response.

getItem

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

See Also:

IIndexedNode.getItem(java.lang.String)

getItems

public List<OasResponse> getItems()

Description copied from interface: IIndexedNode

Returns an array of all the child items.

Specified by:

getItems in interface IIndexedNode<OasResponse>

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

See Also:

IIndexedNode.getItemNames()

addItem

public void addItem(String name,
                    OasResponse item)

Description copied from interface: IIndexedNode

Adds a child item.

Specified by:

addItem in interface IIndexedNode<OasResponse>

See Also:

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

deleteItem

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

See Also:

IIndexedNode.deleteItem(java.lang.String)