public abstract class Document extends ExtensibleNode implements IExternalDocumentationParent
Modifier and Type | Field and Description |
---|---|
ExternalDocumentation |
externalDocs |
Info |
info |
List<Tag> |
tags |
_extensions
_attributes, _extraProperties, _modelId, _ownerDocument, _parent, _validationProblems
Constructor and Description |
---|
Document()
Constructor.
|
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.
|
boolean |
isAttached()
Determine if this node has a parent and owner document defined.
|
void |
setExternalDocumentation(ExternalDocumentation externalDocs)
Sets the external documentation.
|
ExternalDocumentation |
setExternalDocumentation(String description,
String url)
Sets the external documentation information.
|
addExtension, clearExtensions, createExtension, getExtension, getExtensions, isExtensible, removeExtension
addExtraProperty, addValidationProblem, attachToParent, clearAttributes, clearValidationProblems, getAttribute, getAttributeNames, getExtraProperty, getExtraPropertyNames, getValidationProblemCodes, getValidationProblems, getValidationProblemsFor, hasExtraProperties, modelId, ownerDocument, parent, removeExtraProperty, setAttribute
public Info info
public ExternalDocumentation externalDocs
public abstract DocumentType getDocumentType()
public void accept(IVisitor visitor)
IVisitable
accept
in interface IVisitable
accept
in class Node
Node.accept(io.apicurio.datamodels.core.visitors.IVisitor)
public abstract Info createInfo()
public abstract Tag createTag()
public Tag addTag(String name, String description)
name
- description
- public abstract ExternalDocumentation createExternalDocumentation()
createExternalDocumentation
in interface IExternalDocumentationParent
public void setExternalDocumentation(ExternalDocumentation externalDocs)
IExternalDocumentationParent
public ExternalDocumentation setExternalDocumentation(String description, String url)
description
- url
- public boolean isAttached()
Node
isAttached
in class Node
Copyright © 2020 Red Hat. All rights reserved.