io.apicurio.datamodels.openapi.v3.models

Class Oas30Parameter

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.core.models.common.Parameter

io.apicurio.datamodels.openapi.models.OasParameter

io.apicurio.datamodels.openapi.v3.models.Oas30Parameter

All Implemented Interfaces:

IExampleParent, INamed, IReferenceNode, IVisitable, IOas30MediaTypeParent

Direct Known Subclasses:

Oas30ParameterDefinition

public class Oas30Parameter
extends OasParameter
implements IReferenceNode, IOas30MediaTypeParent, IExampleParent

Models an OpenAPI 3.0.x parameter.

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	allowReserved
Map<String,Oas30MediaType>	content
Boolean	deprecated
Object	example
Map<String,Oas30Example>	examples
Boolean	explode
String	style

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

allowEmptyValue, in, required

Fields inherited from class io.apicurio.datamodels.core.models.common.Parameter

$ref, description, name, schema

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
Oas30Parameter() Constructor.
Oas30Parameter(String named) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addExample(Oas30Example example) Adds the Example to the map of examples.
void	addMediaType(String name, Oas30MediaType mediaType) Adds a media type.
Oas30Example	createExample(String name) Creates a child Example model.
Oas30MediaType	createMediaType(String name) Creates a media type.
Schema	createSchema()
Oas30Example	getExample(String name) Gets a single example by name.
List<Oas30Example>	getExamples() Gets all examples.
Oas30MediaType	getMediaType(String name) Gets a single media type by name.
List<Oas30MediaType>	getMediaTypes() Gets a list of all media types.
Oas30Example	removeExample(String name) Removes an Example and returns it.
Oas30MediaType	removeMediaType(String name) Removes a single media type and returns it.

Methods inherited from class io.apicurio.datamodels.core.models.common.Parameter

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

deprecated

public Boolean deprecated

style

public String style

explode

public Boolean explode

allowReserved

public Boolean allowReserved

example

public Object example

examples

public Map<String,Oas30Example> examples

content

public Map<String,Oas30MediaType> content

Constructor Detail

Oas30Parameter

public Oas30Parameter()

Constructor.

Oas30Parameter

public Oas30Parameter(String named)

Constructor.

Method Detail

createSchema

public Schema createSchema()

Specified by:

createSchema in class Parameter

See Also:

Parameter.createSchema()

createExample

public Oas30Example createExample(String name)

Creates a child Example model.

addExample

public void addExample(Oas30Example example)

Adds the Example to the map of examples.

Parameters:

example -

removeExample

public Oas30Example removeExample(String name)

Removes an Example and returns it.

Parameters:

name -

getExample

public Oas30Example getExample(String name)

Gets a single example by name.

Parameters:

name -

getExamples

public List<Oas30Example> getExamples()

Gets all examples.

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