io.apicurio.datamodels.openapi.v3.models

Class Oas30Response

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.openapi.models.OasResponse

io.apicurio.datamodels.openapi.v3.models.Oas30Response

All Implemented Interfaces:

INamed, IReferenceNode, IVisitable, IOas30MediaTypeParent

Direct Known Subclasses:

Oas30ResponseDefinition

public class Oas30Response
extends OasResponse
implements IOas30MediaTypeParent

Models an OpenAPI 3.0.x response.

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,Oas30MediaType>	content
Map<String,Oas30Header>	headers
Map<String,Oas30Link>	links

Fields inherited from class io.apicurio.datamodels.openapi.models.OasResponse

$ref, description

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
Oas30Response(String statusCode) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addHeader(String name, Oas30Header header) Adds a header.
void	addLink(String name, Oas30Link link) Adds a link.
void	addMediaType(String name, Oas30MediaType mediaType) Adds a media type.
Oas30Header	createHeader(String name) Creates a header.
Oas30Link	createLink(String name) Creates a link.
Oas30MediaType	createMediaType(String name) Creates a media type.
Oas30Header	getHeader(String name) Gets a single header by name.
List<Oas30Header>	getHeaders() Gets a list of all headers.
Oas30Link	getLink(String name) Gets a single link by name.
List<Oas30Link>	getLinks() Gets a list of all links.
Oas30MediaType	getMediaType(String name) Gets a single media type by name.
List<Oas30MediaType>	getMediaTypes() Gets a list of all media types.
String	getStatusCode() Gets the status code.
Oas30Header	removeHeader(String name) Removes a single header and returns it.
Oas30Link	removeLink(String name) Removes a single link and returns it.
Oas30MediaType	removeMediaType(String name) Removes a single media type and returns it.

Methods inherited from class io.apicurio.datamodels.openapi.models.OasResponse

accept, getName, rename

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

headers

public Map<String,Oas30Header> headers

content

public Map<String,Oas30MediaType> content

links

public Map<String,Oas30Link> links

Constructor Detail

Oas30Response

public Oas30Response(String statusCode)

Constructor.

Parameters:

statusCode -

Method Detail

getStatusCode

public String getStatusCode()

Gets the status code.

Overrides:

getStatusCode in class OasResponse

createHeader

public Oas30Header createHeader(String name)

Creates a header.

Parameters:

name -

addHeader

public void addHeader(String name,
                      Oas30Header header)

Adds a header.

Parameters:

name -

header -

getHeader

public Oas30Header getHeader(String name)

Gets a single header by name.

Parameters:

name -

removeHeader

public Oas30Header removeHeader(String name)

Removes a single header and returns it. This may return null or undefined if none found.

Parameters:

name -

getHeaders

public List<Oas30Header> getHeaders()

Gets a list of all headers.

createMediaType

public Oas30MediaType createMediaType(String name)

Description copied from interface: IOas30MediaTypeParent

Creates a media type.

Specified by:

createMediaType in interface IOas30MediaTypeParent

See Also:

IOas30MediaTypeParent.createMediaType(java.lang.String)

addMediaType

public void addMediaType(String name,
                         Oas30MediaType mediaType)

Description copied from interface: IOas30MediaTypeParent

Adds a media type.

Specified by:

addMediaType in interface IOas30MediaTypeParent

See Also:

IOas30MediaTypeParent.addMediaType(java.lang.String, io.apicurio.datamodels.openapi.v3.models.Oas30MediaType)

getMediaType

public Oas30MediaType getMediaType(String name)

Description copied from interface: IOas30MediaTypeParent

Gets a single media type by name.

Specified by:

getMediaType in interface IOas30MediaTypeParent

See Also:

IOas30MediaTypeParent.getMediaType(java.lang.String)

removeMediaType

public Oas30MediaType removeMediaType(String name)

Description copied from interface: IOas30MediaTypeParent

Removes a single media type and returns it. This may return null or undefined if none found.

Specified by:

removeMediaType in interface IOas30MediaTypeParent

See Also:

IOas30MediaTypeParent.removeMediaType(java.lang.String)

getMediaTypes

public List<Oas30MediaType> getMediaTypes()

Description copied from interface: IOas30MediaTypeParent

Gets a list of all media types.

Specified by:

getMediaTypes in interface IOas30MediaTypeParent

See Also:

IOas30MediaTypeParent.getMediaTypes()

createLink

public Oas30Link createLink(String name)

Creates a link.

Parameters:

name -

addLink

public void addLink(String name,
                    Oas30Link link)

Adds a link.

Parameters:

name -

link -

getLink

public Oas30Link getLink(String name)

Gets a single link by name.

Parameters:

name -

removeLink

public Oas30Link removeLink(String name)

Removes a single link and returns it. This may return null or undefined if none found.

Parameters:

name -

getLinks

public List<Oas30Link> getLinks()

Gets a list of all links.