io.apicurio.datamodels.openapi.v3.models

Class Oas30MediaType

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.openapi.v3.models.Oas30MediaType

All Implemented Interfaces:

IExampleParent, INamed, IVisitable

public class Oas30MediaType
extends ExtensibleNode
implements INamed, IExampleParent

Models an OpenAPI 3.0.x media type.

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,Oas30Encoding>	encoding
Object	example
Map<String,Oas30Example>	examples
Oas30Schema	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
Oas30MediaType(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	addEncoding(String name, Oas30Encoding encoding) Adds a encoding.
void	addExample(Oas30Example example) Adds the Example to the map of examples.
Oas30Encoding	createEncoding(String name) Creates a encoding.
Oas30Example	createExample(String name) Creates a child Example model.
Oas30Schema	createSchema() Creates a child schema model.
Oas30Encoding	getEncoding(String name) Gets a single encoding by name.
List<Oas30Encoding>	getEncodings() Gets a list of all encodings.
Oas30Example	getExample(String name) Gets a single example by name.
List<Oas30Example>	getExamples() Gets all examples.
String	getName() Gets the definition name.
Oas30Encoding	removeEncoding(String name) Removes a single encoding and returns it.
Oas30Example	removeExample(String name) Removes an Example and returns it.
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

schema

public Oas30Schema schema

example

public Object example

examples

public Map<String,Oas30Example> examples

encoding

public Map<String,Oas30Encoding> encoding

Constructor Detail

Oas30MediaType

public Oas30MediaType(String name)

Constructor.

Parameters:

name -

Method Detail

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)

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)

createSchema

public Oas30Schema createSchema()

Creates a child schema model.

createEncoding

public Oas30Encoding createEncoding(String name)

Creates a encoding.

Parameters:

name -

addEncoding

public void addEncoding(String name,
                        Oas30Encoding encoding)

Adds a encoding.

Parameters:

name -

encoding -

getEncoding

public Oas30Encoding getEncoding(String name)

Gets a single encoding by name.

Parameters:

name -

removeEncoding

public Oas30Encoding removeEncoding(String name)

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

Parameters:

name -

getEncodings

public List<Oas30Encoding> getEncodings()

Gets a list of all encodings.

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.