io.apicurio.datamodels.asyncapi.models

Class AaiMessageBase

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.asyncapi.models.AaiMessageBase

All Implemented Interfaces:

INamed, IVisitable

Direct Known Subclasses:

AaiMessage, AaiMessageTrait

public abstract class AaiMessageBase
extends ExtensibleNode
implements INamed

Contains shared fields in AaiMessage and AaiMessageTrait

Author:

Jakub Senko

Field Summary

Fields

Modifier and Type	Field and Description
String	_name
String	$ref
String	contentType
AaiCorrelationId	correlationId
String	description
Map<String,Object>	examples Represents `Map[string, any]` type.
ExternalDocumentation	externalDocs
Map<String,AaiHeaderItem>	headers Represents `Map[string, Schema Object | Reference Object]` type.
String	name
Map<String,AaiProtocolInfo>	protocolInfo
String	schemaFormat
String	summary
List<Tag>	tags
String	title

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
AaiMessageBase(Node parent)
AaiMessageBase(Node parent, String name)
AaiMessageBase(String name) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract void	addHeaderItem(AaiHeaderItem item)
abstract void	addProtocolInfo(AaiProtocolInfo item)
abstract void	addTag(AaiTag tag)
abstract List<AaiHeaderItem>	getHeadersList()
String	getName() Gets the definition name.
abstract List<AaiProtocolInfo>	getProtocolInfoList()
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

accept, 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

_name

public String _name

$ref

public String $ref

headers

public Map<String,AaiHeaderItem> headers

Represents `Map[string, Schema Object | Reference Object]` type.

correlationId

public AaiCorrelationId correlationId

schemaFormat

public String schemaFormat

contentType

public String contentType

name

public String name

title

public String title

summary

public String summary

description

public String description

tags

public List<Tag> tags

externalDocs

public ExternalDocumentation externalDocs

protocolInfo

public Map<String,AaiProtocolInfo> protocolInfo

examples

public Map<String,Object> examples

Represents `Map[string, any]` type.

Objects of `any` type are deserialized as follows: In TypeScript, this field contains the raw JS object, in case of Java it is a ObjectNode.

See Also:

AsyncAPI 2.0.0 spec

Constructor Detail

AaiMessageBase

public AaiMessageBase(String name)

Constructor.

AaiMessageBase

public AaiMessageBase(Node parent)

AaiMessageBase

public AaiMessageBase(Node parent,
                      String 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)

getHeadersList

public abstract List<AaiHeaderItem> getHeadersList()

getProtocolInfoList

public abstract List<AaiProtocolInfo> getProtocolInfoList()

addHeaderItem

public abstract void addHeaderItem(AaiHeaderItem item)

addTag

public abstract void addTag(AaiTag tag)

addProtocolInfo

public abstract void addProtocolInfo(AaiProtocolInfo item)