io.apicurio.datamodels.core.visitors

Class Traverser

java.lang.Object

io.apicurio.datamodels.core.visitors.Traverser

All Implemented Interfaces:

ITraverser, IVisitor

Direct Known Subclasses:

AaiTraverser, OasTraverser

public class Traverser
extends Object
implements ITraverser, IVisitor

A base class for all traversers. All domain specific traversers should extend this and then provide domain specific functionality.

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
protected IVisitor	visitor

Constructor Summary

Constructors

Constructor and Description
Traverser(IVisitor visitor) C'tor.

Method Summary

Modifier and Type	Method and Description
void	traverse(Node node) Called to traverse the data model starting at the given node and traversing down until this node and all child nodes have been visited.
protected void	traverseCollection(Collection<? extends IVisitable> items) Traverse the items of the given array.
protected void	traverseDocument(Document node) Subclasses can override this to provide version-specific traversal of the root document.
protected void	traverseExtensions(ExtensibleNode node) Traverse the extension nodes, if any are found.
protected void	traverseIfNotNull(IVisitable node) Traverse into the given node, unless it's null.
protected void	traverseIndexedNode(IIndexedNode<? extends Node> node) Traverse all children of the indexed node.
protected void	traverseOAuthFlow(OAuthFlow node) Traverse an OAuth flow.
protected void	traverseOAuthFlows(OAuthFlows node) Traverses an oauth flows node.
protected void	traverseOperation(Operation node)
protected void	traverseParameter(Parameter node)
protected void	traverseSchema(Schema node)
protected void	traverseSecurityScheme(SecurityScheme node)
protected void	traverseValidationProblems(Node node) Traverse the validation problems, if any are found.
void	visitContact(Contact node)
void	visitDocument(Document node)
void	visitExtension(Extension node)
void	visitExternalDocumentation(ExternalDocumentation node)
void	visitInfo(Info node)
void	visitLicense(License node)
void	visitOperation(Operation node)
void	visitParameter(Parameter node)
void	visitParameterDefinition(IDefinition node)
void	visitSchema(Schema node)
void	visitSchemaDefinition(IDefinition node)
void	visitSecurityRequirement(SecurityRequirement node)
void	visitSecurityScheme(SecurityScheme node)
void	visitTag(Tag node)
void	visitValidationProblem(ValidationProblem problem)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

visitor

protected IVisitor visitor

Constructor Detail

Traverser

public Traverser(IVisitor visitor)

C'tor.

Parameters:

visitor -

Method Detail

traverseCollection

protected void traverseCollection(Collection<? extends IVisitable> items)

Traverse the items of the given array.

Parameters:

items -

traverseExtensions

protected void traverseExtensions(ExtensibleNode node)

Traverse the extension nodes, if any are found.

Parameters:

node -

traverseIndexedNode

protected void traverseIndexedNode(IIndexedNode<? extends Node> node)

Traverse all children of the indexed node.

Parameters:

node -

traverseValidationProblems

protected void traverseValidationProblems(Node node)

Traverse the validation problems, if any are found.

Parameters:

node -

traverse

public void traverse(Node node)

Called to traverse the data model starting at the given node and traversing down until this node and all child nodes have been visited.

Specified by:

traverse in interface ITraverser

Parameters:

node -

traverseIfNotNull

protected void traverseIfNotNull(IVisitable node)

Traverse into the given node, unless it's null.

Parameters:

node -

visitDocument

public final void visitDocument(Document node)

Specified by:

visitDocument in interface IVisitor

See Also:

IVisitor.visitDocument(io.apicurio.datamodels.core.models.Document)

traverseDocument

protected void traverseDocument(Document node)

Subclasses can override this to provide version-specific traversal of the root document.

Parameters:

node -

visitExtension

public void visitExtension(Extension node)

Specified by:

visitExtension in interface IVisitor

See Also:

IVisitor.visitExtension(io.apicurio.datamodels.core.models.Extension)

visitValidationProblem

public void visitValidationProblem(ValidationProblem problem)

Specified by:

visitValidationProblem in interface IVisitor

See Also:

IVisitor.visitValidationProblem(io.apicurio.datamodels.core.models.ValidationProblem)

visitInfo

public void visitInfo(Info node)

Specified by:

visitInfo in interface IVisitor

See Also:

IVisitor.visitInfo(io.apicurio.datamodels.core.models.common.Info)

visitContact

public void visitContact(Contact node)

Specified by:

visitContact in interface IVisitor

See Also:

IVisitor.visitContact(io.apicurio.datamodels.core.models.common.Contact)

visitLicense

public void visitLicense(License node)

Specified by:

visitLicense in interface IVisitor

See Also:

IVisitor.visitLicense(io.apicurio.datamodels.core.models.common.License)

visitTag

public void visitTag(Tag node)

Specified by:

visitTag in interface IVisitor

See Also:

IVisitor.visitTag(io.apicurio.datamodels.core.models.common.Tag)

visitSecurityRequirement

public void visitSecurityRequirement(SecurityRequirement node)

Specified by:

visitSecurityRequirement in interface IVisitor

See Also:

IVisitor.visitSecurityRequirement(io.apicurio.datamodels.core.models.common.SecurityRequirement)

visitExternalDocumentation

public void visitExternalDocumentation(ExternalDocumentation node)

Specified by:

visitExternalDocumentation in interface IVisitor

See Also:

IVisitor.visitExternalDocumentation(io.apicurio.datamodels.core.models.common.ExternalDocumentation)

visitSchema

public void visitSchema(Schema node)

Specified by:

visitSchema in interface IVisitor

See Also:

IVisitor.visitSchema(io.apicurio.datamodels.core.models.common.Schema)

traverseSchema

protected void traverseSchema(Schema node)

visitParameter

public void visitParameter(Parameter node)

Specified by:

visitParameter in interface IVisitor

See Also:

IVisitor.visitParameter(io.apicurio.datamodels.core.models.common.Parameter)

traverseParameter

protected void traverseParameter(Parameter node)

visitParameterDefinition

public void visitParameterDefinition(IDefinition node)

Specified by:

visitParameterDefinition in interface IVisitor

See Also:

IVisitor.visitParameterDefinition(io.apicurio.datamodels.core.models.common.IDefinition)

visitOperation

public void visitOperation(Operation node)

Specified by:

visitOperation in interface IVisitor

See Also:

IVisitor.visitOperation(io.apicurio.datamodels.core.models.common.Operation)

traverseOperation

protected void traverseOperation(Operation node)

visitSecurityScheme

public void visitSecurityScheme(SecurityScheme node)

Specified by:

visitSecurityScheme in interface IVisitor

See Also:

IVisitor.visitSecurityScheme(io.apicurio.datamodels.core.models.common.SecurityScheme)

traverseSecurityScheme

protected void traverseSecurityScheme(SecurityScheme node)

visitSchemaDefinition

public void visitSchemaDefinition(IDefinition node)

Specified by:

visitSchemaDefinition in interface IVisitor

See Also:

IVisitor.visitSchemaDefinition(io.apicurio.datamodels.core.models.common.IDefinition)

traverseOAuthFlow

protected void traverseOAuthFlow(OAuthFlow node)

Traverse an OAuth flow.

Parameters:

node -

traverseOAuthFlows

protected void traverseOAuthFlows(OAuthFlows node)

Traverses an oauth flows node.

Parameters:

node -