io.apicurio.datamodels.core.models

Class Document

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.core.models.Document

All Implemented Interfaces:

IExternalDocumentationParent, IVisitable

Direct Known Subclasses:

AaiDocument, OasDocument

public abstract class Document
extends ExtensibleNode
implements IExternalDocumentationParent

The base class for all document nodes. This base class is extended by the OpenAPI and AsyncAPI data model classes. A Document model represents the root node of the data model.

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
ExternalDocumentation	externalDocs
Info	info
List<Tag>	tags

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
Document() Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(IVisitor visitor) Called to accept a visitor onto a visitable data model instance.
Tag	addTag(String name, String description) Adds a tag.
abstract ExternalDocumentation	createExternalDocumentation() Creates an External Documentation node.
abstract Info	createInfo() Creates an Info node.
abstract Tag	createTag() Creates a Tag node.
abstract DocumentType	getDocumentType() Called to get the type of document.
void	setExternalDocumentation(ExternalDocumentation externalDocs) Sets the external documentation.
ExternalDocumentation	setExternalDocumentation(String description, String url) Sets the external documentation information.

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

info

public Info info

tags

public List<Tag> tags

externalDocs

public ExternalDocumentation externalDocs

Constructor Detail

Document

public Document()

Constructor.

Method Detail

getDocumentType

public abstract DocumentType getDocumentType()

Called to get the type of document.

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)

createInfo

public abstract Info createInfo()

Creates an Info node.

createTag

public abstract Tag createTag()

Creates a Tag node.

addTag

public Tag addTag(String name,
                  String description)

Adds a tag.

Parameters:

name -

description -

createExternalDocumentation

public abstract ExternalDocumentation createExternalDocumentation()

Creates an External Documentation node.

Specified by:

createExternalDocumentation in interface IExternalDocumentationParent

setExternalDocumentation

public void setExternalDocumentation(ExternalDocumentation externalDocs)

Description copied from interface: IExternalDocumentationParent

Sets the external documentation.

Specified by:

setExternalDocumentation in interface IExternalDocumentationParent

See Also:

IExternalDocumentationParent.setExternalDocumentation(io.apicurio.datamodels.core.models.common.ExternalDocumentation)

setExternalDocumentation

public ExternalDocumentation setExternalDocumentation(String description,
                                                      String url)

Sets the external documentation information.

Parameters:

description -

url -