Package com.blackbuild.klum.ast.runtime.internal.process

Class VisitingPhaseAction

java.lang.Object

com.blackbuild.klum.ast.runtime.internal.process.AbstractPhaseAction

com.blackbuild.klum.ast.runtime.internal.process.VisitingPhaseAction

All Implemented Interfaces:

ModelVisitor, PhaseAction

@Deprecated(since="4.0",
            forRemoval=true)
public abstract class VisitingPhaseAction
extends AbstractPhaseAction
implements ModelVisitor

Deprecated, for removal: This API element is subject to removal in a future version.

since 4.0; extend BuilderVisitingPhaseAction before INSTANTIATE or ModelVisitingPhaseAction afterward

Legacy untyped visitor base retained only to give existing plugins migration guidance.

Nested Class Summary

Nested classes/interfaces inherited from interface com.blackbuild.klum.ast.runtime.internal.layer3.ModelVisitor

ModelVisitor.Action

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VisitingPhaseAction(KlumPhase phase)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute()	Deprecated, for removal: This API element is subject to removal in a future version. Executes the phase on the root element of the model.
protected abstract void	doVisit(@NotNull String path, @NotNull Object element, @Nullable Object container, @Nullable String nameOfFieldInContainer)	Deprecated, for removal: This API element is subject to removal in a future version.
void	visit(@NotNull String path, @NotNull Object element, @Nullable Object container, @Nullable String nameOfFieldInContainer)	Deprecated, for removal: This API element is subject to removal in a future version. Visit the given element.

Methods inherited from class com.blackbuild.klum.ast.runtime.internal.process.AbstractPhaseAction

execute, getPhase, isEmpty, isSet, isUnset, replaceRootObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.blackbuild.klum.ast.runtime.internal.layer3.ModelVisitor

shouldVisit

Methods inherited from interface com.blackbuild.klum.ast.runtime.PhaseAction

getPhaseNumber, getSkipProperty, shouldSkip

Constructor Details

VisitingPhaseAction

protected VisitingPhaseAction(KlumPhase phase)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

doExecute

protected void doExecute()

Deprecated, for removal: This API element is subject to removal in a future version.

Executes the phase on the root element of the model.

Specified by:

doExecute in class AbstractPhaseAction

visit

public void visit(@NotNull
 @NotNull String path,
 @NotNull
 @NotNull Object element,
 @Nullable
 @Nullable Object container,
 @Nullable
 @Nullable String nameOfFieldInContainer)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: ModelVisitor

Visit the given element.

Specified by:

visit in interface ModelVisitor

Parameters:

path - a string (GSON-like) representation of the path from the root to this element

element - the element to visit

container - The object containing this element. If the element is a member of a collection or map, the object containing the collection or map.

nameOfFieldInContainer - The name of the field in the container pointing to this object (or its collection/map

doVisit

protected abstract void doVisit(@NotNull
 @NotNull String path,
 @NotNull
 @NotNull Object element,
 @Nullable
 @Nullable Object container,
 @Nullable
 @Nullable String nameOfFieldInContainer)

Deprecated, for removal: This API element is subject to removal in a future version.