io.apicurio.datamodels.asyncapi.models

Class AaiDocument

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

All Implemented Interfaces:

IExternalDocumentationParent, IVisitable

Direct Known Subclasses:

Aai20Document

public abstract class AaiDocument
extends Document

Models an AsyncAPI root document.

Author:

eric.wittmann@gmail.com, Jakub Senko

Field Summary

Fields

Modifier and Type	Field and Description
String	asyncapi
Map<String,AaiChannelItem>	channels
AaiComponents	components
String	defaultContentType
String	id
List<AaiServer>	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
AaiDocument() Constructor.

Method Summary

Modifier and Type	Method and Description
abstract void	addChannelItem(AaiChannelItem item)
abstract AaiServer	addServer(AaiServer server) Adds a server and returns it.
abstract AaiChannelItem	createChannelItem(String name)
abstract AaiComponents	createComponents()
abstract AaiServer	createServer()
abstract AaiServer	createServer(String url, String description)
abstract List<AaiChannelItem>	getChannels()

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

accept, addTag, createExternalDocumentation, createInfo, createTag, getDocumentType, 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

Field Detail

asyncapi

public String asyncapi

See Also:

AsyncAPI 2.0.0 spec

id

public String id

See Also:

AsyncAPI 2.0.0 spec

channels

public Map<String,AaiChannelItem> channels

See Also:

AsyncAPI 2.0.0 spec

servers

public List<AaiServer> servers

See Also:

AsyncAPI 2.0.0 spec

components

public AaiComponents components

See Also:

AsyncAPI 2.0.0 spec

defaultContentType

public String defaultContentType

Constructor Detail

AaiDocument

public AaiDocument()

Constructor.

Method Detail

createServer

public abstract AaiServer createServer()

createServer

public abstract AaiServer createServer(String url,
                                       String description)

addServer

public abstract AaiServer addServer(AaiServer server)

Adds a server and returns it.

getChannels

public abstract List<AaiChannelItem> getChannels()

createChannelItem

public abstract AaiChannelItem createChannelItem(String name)

addChannelItem

public abstract void addChannelItem(AaiChannelItem item)

createComponents

public abstract AaiComponents createComponents()