io.apicurio.datamodels.asyncapi.v2.models

Class Aai20Document

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.core.models.Document

io.apicurio.datamodels.asyncapi.models.AaiDocument

io.apicurio.datamodels.asyncapi.v2.models.Aai20Document

All Implemented Interfaces:

IExternalDocumentationParent, IVisitable

public class Aai20Document
extends AaiDocument

Models an AsyncAPI root document.

Author:

eric.wittmann@gmail.com, Jakub Senko

Field Summary

Fields inherited from class io.apicurio.datamodels.asyncapi.models.AaiDocument

asyncapi, channels, components, defaultContentType, id, servers

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

externalDocs, info, 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
Aai20Document() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addChannelItem(AaiChannelItem item)
AaiServer	addServer(AaiServer server) Adds a server and returns it.
Aai20ChannelItem	createChannelItem(String name)
Aai20Components	createComponents()
Aai20ExternalDocumentation	createExternalDocumentation() Creates an External Documentation node.
Aai20Info	createInfo() Creates an Info node.
Aai20Server	createServer() Creates an AAI 2.0 Server object.
Aai20Server	createServer(String url, String description) Creates an AAI 2.0 Server object.
Aai20Tag	createTag() Creates a Tag node.
List<AaiChannelItem>	getChannels()
DocumentType	getDocumentType() Called to get the type of document.

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

accept, addTag, setExternalDocumentation, setExternalDocumentation

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

Constructor Detail

Aai20Document

public Aai20Document()

Constructor.

Method Detail

getDocumentType

public DocumentType getDocumentType()

Description copied from class: Document

Called to get the type of document.

Specified by:

getDocumentType in class Document

See Also:

Document.getDocumentType()

createInfo

public Aai20Info createInfo()

Description copied from class: Document

Creates an Info node.

Specified by:

createInfo in class Document

See Also:

Document.createInfo()

createTag

public Aai20Tag createTag()

Description copied from class: Document

Creates a Tag node.

Specified by:

createTag in class Document

See Also:

Document.createTag()

createExternalDocumentation

public Aai20ExternalDocumentation createExternalDocumentation()

Description copied from class: Document

Creates an External Documentation node.

Specified by:

createExternalDocumentation in interface IExternalDocumentationParent

Specified by:

createExternalDocumentation in class Document

See Also:

Document.createExternalDocumentation()

createServer

public Aai20Server createServer()

Creates an AAI 2.0 Server object.

Specified by:

createServer in class AaiDocument

createServer

public Aai20Server createServer(String url,
                                String description)

Creates an AAI 2.0 Server object.

Specified by:

createServer in class AaiDocument

addServer

public AaiServer addServer(AaiServer server)

Description copied from class: AaiDocument

Adds a server and returns it.

Specified by:

addServer in class AaiDocument

getChannels

public List<AaiChannelItem> getChannels()

Specified by:

getChannels in class AaiDocument

createChannelItem

public Aai20ChannelItem createChannelItem(String name)

Specified by:

createChannelItem in class AaiDocument

addChannelItem

public void addChannelItem(AaiChannelItem item)

Specified by:

addChannelItem in class AaiDocument

createComponents

public Aai20Components createComponents()

Specified by:

createComponents in class AaiDocument