io.apicurio.datamodels.openapi.v3.models

Class Oas30Encoding

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.openapi.v3.models.Oas30Encoding

All Implemented Interfaces:

INamed, IVisitable

public class Oas30Encoding
extends ExtensibleNode
implements INamed

Models an OpenAPI 3.0.x Encoding.

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	allowReserved
String	contentType
Boolean	explode
Map<String,Oas30Header>	headers
String	style

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
Oas30Encoding(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	addHeader(String name, Oas30Header header) Adds a header.
Oas30Header	createHeader(String name) Creates a header.
Oas30Header	getHeader(String name) Gets a single header by name.
List<String>	getHeaderNames() Gets the header names.
List<Oas30Header>	getHeaders() Gets a list of all headers.
String	getName() Gets the definition name.
Oas30Header	removeHeader(String name) Removes a single header 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

contentType

public String contentType

headers

public Map<String,Oas30Header> headers

style

public String style

explode

public Boolean explode

allowReserved

public Boolean allowReserved

Constructor Detail

Oas30Encoding

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

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 -

getHeaderNames

public List<String> getHeaderNames()

Gets the header names.

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.