io.apicurio.datamodels.openapi.v2.models

Class Oas20Headers

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.openapi.v2.models.Oas20Headers

All Implemented Interfaces:

IIndexedNode<Oas20Header>, IVisitable

public class Oas20Headers
extends Node
implements IIndexedNode<Oas20Header>

Author:

eric.wittmann@gmail.com

Field Summary

Fields inherited from class io.apicurio.datamodels.core.models.Node

_attributes, _extraProperties, _modelId, _ownerDocument, _parent, _validationProblems

Constructor Summary

Constructors

Constructor and Description
Oas20Headers() Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(IVisitor visitor) Called to accept a visitor onto a visitable data model instance.
Oas20Header	addHeader(String headerName, Oas20Header header) Adds a header.
void	addItem(String name, Oas20Header item) Adds a child item.
Oas20Header	createHeader(String headerName) Creates a header model.
Oas20Header	deleteItem(String name) Deletes a child item by name and returns the deleted child or undefined if there wasn't one.
Oas20Header	getHeader(String headerName) Gets a single header by name.
List<String>	getHeaderNames() Returns all the header names.
List<Oas20Header>	getHeaders() Returns an array of all the headers.
Oas20Header	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<Oas20Header>	getItems() Returns an array of all the child items.
Oas20Header	removeHeader(String headerName) Removes a single header.

Methods inherited from class io.apicurio.datamodels.core.models.Node

addExtraProperty, addValidationProblem, clearAttributes, clearValidationProblems, getAttribute, getAttributeNames, getExtraProperty, getExtraPropertyNames, getValidationProblemCodes, getValidationProblems, getValidationProblemsFor, hasExtraProperties, isExtensible, modelId, ownerDocument, parent, removeExtraProperty, setAttribute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Oas20Headers

public Oas20Headers()

Constructor.

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)

createHeader

public Oas20Header createHeader(String headerName)

Creates a header model.

Parameters:

headerName -

getHeader

public Oas20Header getHeader(String headerName)

Gets a single header by name.

Parameters:

headerName -

getHeaders

public List<Oas20Header> getHeaders()

Returns an array of all the headers.

getHeaderNames

public List<String> getHeaderNames()

Returns all the header names.

removeHeader

public Oas20Header removeHeader(String headerName)

Removes a single header.

Parameters:

headerName -

addHeader

public Oas20Header addHeader(String headerName,
                             Oas20Header header)

Adds a header.

Parameters:

headerName -

header -

getItem

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

See Also:

IIndexedNode.getItem(java.lang.String)

getItems

public List<Oas20Header> getItems()

Description copied from interface: IIndexedNode

Returns an array of all the child items.

Specified by:

getItems in interface IIndexedNode<Oas20Header>

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

See Also:

IIndexedNode.getItemNames()

addItem

public void addItem(String name,
                    Oas20Header item)

Description copied from interface: IIndexedNode

Adds a child item.

Specified by:

addItem in interface IIndexedNode<Oas20Header>

See Also:

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

deleteItem

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

See Also:

IIndexedNode.deleteItem(java.lang.String)