Module dev.metaschema.core

Package dev.metaschema.core.metapath.item.node

Class RecursionCollectingNodeItemVisitor

java.lang.Object

dev.metaschema.core.metapath.item.node.AbstractNodeItemVisitor<CONTEXT,RESULT>

dev.metaschema.core.metapath.item.node.AbstractRecursionPreventingNodeItemVisitor<Void,Void>

dev.metaschema.core.metapath.item.node.RecursionCollectingNodeItemVisitor

All Implemented Interfaces:

INodeItemVisitor<Void,Void>

public class RecursionCollectingNodeItemVisitor
extends AbstractRecursionPreventingNodeItemVisitor<Void,Void>

Analyzes a Metaschema module to identify assembly definitions that are recursive.

This visitor traverses the module structure and tracks assembly definitions that contain themselves as descendants, collecting locations where recursion occurs.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RecursionCollectingNodeItemVisitor.AssemblyRecord	Records information about an assembly definition, including whether it is recursive and where it is used.

Constructor Summary

Constructors

Constructor	Description
RecursionCollectingNodeItemVisitor()

Method Summary

Modifier and Type	Method	Description
protected Void	defaultResult()	The initial, default visitation result, which will be used as the basis for aggregating results produced when visiting.
Set<RecursionCollectingNodeItemVisitor.AssemblyRecord>	getRecursiveAssemblyDefinitions()	Get the identified assembly definitions that recurse.
void	visit(IModule module)	Visit the provided module.
Void	visitAssembly(IAssemblyInstanceGroupedNodeItem item, Void context)	This callback is called when an IAssemblyInstanceGroupedNodeItem is visited.
Void	visitAssembly(IAssemblyNodeItem item, Void context)	This callback is called when an IAssemblyNodeItem is visited.

Methods inherited from class dev.metaschema.core.metapath.item.node.AbstractRecursionPreventingNodeItemVisitor

isDecendant

Methods inherited from class dev.metaschema.core.metapath.item.node.AbstractNodeItemVisitor

aggregateResult, shouldVisitNextChild, shouldVisitNextChild, visit, visitDocument, visitField, visitFlag, visitFlags, visitMetaschema, visitModelChildren

Methods inherited from class java.lang.Object

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

Constructor Details

RecursionCollectingNodeItemVisitor

public RecursionCollectingNodeItemVisitor()

Method Details

getRecursiveAssemblyDefinitions

@NonNull
public Set<RecursionCollectingNodeItemVisitor.AssemblyRecord> getRecursiveAssemblyDefinitions()

Get the identified assembly definitions that recurse.

Returns:

the definitions that recurse

See Also:

• RecursionCollectingNodeItemVisitor.AssemblyRecord.isRecursive()

visit

public void visit(@NonNull
 IModule module)

Visit the provided module.

Parameters:

module - the Metaschema module to visit

visitAssembly

public Void visitAssembly(IAssemblyNodeItem item,
 Void context)

Description copied from interface: INodeItemVisitor

This callback is called when an IAssemblyNodeItem is visited.

Specified by:

visitAssembly in interface INodeItemVisitor<Void,Void>

Overrides:

visitAssembly in class AbstractRecursionPreventingNodeItemVisitor<Void,Void>

Parameters:

item - the visited item

context - provides contextual information for use by the visitor

Returns:

the visitation result

visitAssembly

public Void visitAssembly(IAssemblyInstanceGroupedNodeItem item,
 Void context)

Description copied from interface: INodeItemVisitor

This callback is called when an IAssemblyInstanceGroupedNodeItem is visited.

Specified by:

visitAssembly in interface INodeItemVisitor<Void,Void>

Overrides:

visitAssembly in class AbstractNodeItemVisitor<Void,Void>

Parameters:

item - the visited item

context - provides contextual information for use by the visitor

Returns:

the visitation result

defaultResult

protected Void defaultResult()

Description copied from class: AbstractNodeItemVisitor

The initial, default visitation result, which will be used as the basis for aggregating results produced when visiting.

Specified by:

defaultResult in class AbstractNodeItemVisitor<Void,Void>

Returns:

the default result

See Also:

• AbstractNodeItemVisitor.aggregateResult(Object, Object, Object)