io.apicurio.datamodels.core.models.common

Class Tag

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.core.models.common.Tag

All Implemented Interfaces:

IExternalDocumentationParent, INamed, IVisitable

Direct Known Subclasses:

AaiTag, OasTag

public abstract class Tag
extends ExtensibleNode
implements IExternalDocumentationParent, INamed

Models a Tag node.

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
String	description
ExternalDocumentation	externalDocs
String	name

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
Tag() Constructor.
Tag(String name) Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(IVisitor visitor) Called to accept a visitor onto a visitable data model instance.
abstract ExternalDocumentation	createExternalDocumentation() Creates an External Documentation node.
String	getName() Gets the definition name.
void	rename(String newName) Renames the definition.
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

name

public String name

description

public String description

externalDocs

public ExternalDocumentation externalDocs

Constructor Detail

Tag

public Tag()

Constructor.

Tag

public Tag(String name)

Constructor.

Method Detail

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)

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 -

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)