Package eu.maveniverse.domtrip

Interface DomTripVisitor

public interface DomTripVisitor

Visitor interface for structured depth-first tree traversal with enter/exit lifecycle callbacks.

This complements the existing stream-based navigation (Element.descendants(), ElementQuery) with a pattern better suited for transformations needing context tracking (depth, ancestors, accumulated state).

Traversal Order:

The visitor performs a depth-first traversal: for each element, enterElement(Element) is called first, then all children are visited recursively, and finally exitElement(Element) is called.

Flow Control:

Visit methods return an DomTripVisitor.Action to control traversal:

• DomTripVisitor.Action.CONTINUE - Continue normal traversal
• DomTripVisitor.Action.SKIP - Skip children of current element (only meaningful from enterElement)
• DomTripVisitor.Action.STOP - Abort traversal entirely

Usage Example:

{@code
 element.accept(new DomTripVisitor() {

Since:

1.3.0

See Also:

Node.accept(DomTripVisitor), TreeWalker

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DomTripVisitor.Action	Controls traversal flow during a visitor walk.

Method Summary

Modifier and Type	Method	Description
default DomTripVisitor.Action	enterElement(Element element)	Called when entering an element during depth-first traversal.
default void	exitElement(Element element)	Called after all children of an element have been visited.
default DomTripVisitor.Action	visitComment(Comment comment)	Called for comment nodes during traversal.
default DomTripVisitor.Action	visitProcessingInstruction(ProcessingInstruction pi)	Called for processing instruction nodes during traversal.
default DomTripVisitor.Action	visitText(Text text)	Called for text nodes during traversal.

Method Detail

enterElement

default DomTripVisitor.Action enterElement(Element element)

Called when entering an element during depth-first traversal.

This is called before visiting any of the element's children. Return DomTripVisitor.Action.SKIP to skip the element's children, or DomTripVisitor.Action.STOP to abort the entire traversal.

Parameters:

element - the element being entered

Returns:

the action to take: DomTripVisitor.Action.CONTINUE, DomTripVisitor.Action.SKIP, or DomTripVisitor.Action.STOP

exitElement

default void exitElement(Element element)

Called after all children of an element have been visited.

This is always called for elements that were entered (even if children were skipped via DomTripVisitor.Action.SKIP), unless the traversal was stopped via DomTripVisitor.Action.STOP.

Parameters:

element - the element being exited

visitText

default DomTripVisitor.Action visitText(Text text)

Called for text nodes during traversal.

Parameters:

text - the text node being visited

Returns:

the action to take: DomTripVisitor.Action.CONTINUE or DomTripVisitor.Action.STOP

visitComment

default DomTripVisitor.Action visitComment(Comment comment)

Called for comment nodes during traversal.

Parameters:

comment - the comment node being visited

Returns:

the action to take: DomTripVisitor.Action.CONTINUE or DomTripVisitor.Action.STOP

visitProcessingInstruction

default DomTripVisitor.Action visitProcessingInstruction(ProcessingInstruction pi)

Called for processing instruction nodes during traversal.

Parameters:

pi - the processing instruction being visited

Returns:

the action to take: DomTripVisitor.Action.CONTINUE or DomTripVisitor.Action.STOP