com.helger.commons.hierarchy.visit

Class ChildrenProviderHierarchyVisitor<CHILDTYPE>

java.lang.Object

com.helger.commons.hierarchy.visit.ChildrenProviderHierarchyVisitor<CHILDTYPE>

Type Parameters:

CHILDTYPE - The type of children to visit

All Implemented Interfaces:

IHierarchyVisitor<CHILDTYPE>

@Immutable
public class ChildrenProviderHierarchyVisitor<CHILDTYPE>
extends Object
implements IHierarchyVisitor<CHILDTYPE>

Recursively visit all children provided by a given IChildrenProvider and call a callback for each visited child.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
ChildrenProviderHierarchyVisitor(IChildrenProvider<CHILDTYPE> aChildrenProvider, IHierarchyVisitorCallback<? super CHILDTYPE> aCallback)

Method Summary

Methods

Modifier and Type	Method and Description
IHierarchyVisitorCallback<? super CHILDTYPE>	getCallback()
IChildrenProvider<CHILDTYPE>	getChildrenProvider()
void	visit(CHILDTYPE aStartObject, boolean bInvokeOnStartObject) Visit all objects, starting specified one.
static <CHILDTYPE> void	visitAll(IChildrenProvider<CHILDTYPE> aChildrenProvider, IHierarchyVisitorCallback<? super CHILDTYPE> aCallback, boolean bInvokeOnStartObject)
static <CHILDTYPE extends IHasChildren<CHILDTYPE>> void	visitAll(IHierarchyVisitorCallback<? super CHILDTYPE> aCallback, boolean bInvokeOnStartObject)
static <CHILDTYPE> void	visitFrom(CHILDTYPE aStartObject, IChildrenProvider<CHILDTYPE> aChildrenProvider, IHierarchyVisitorCallback<? super CHILDTYPE> aCallback, boolean bInvokeOnStartObject)
static <CHILDTYPE extends IHasChildren<CHILDTYPE>> void	visitFrom(CHILDTYPE aStartObject, IHierarchyVisitorCallback<? super CHILDTYPE> aCallback, boolean bInvokeOnStartObject)

Methods inherited from class java.lang.Object

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

Constructor Detail

ChildrenProviderHierarchyVisitor

public ChildrenProviderHierarchyVisitor(@Nonnull
                                IChildrenProvider<CHILDTYPE> aChildrenProvider,
                                @Nonnull
                                IHierarchyVisitorCallback<? super CHILDTYPE> aCallback)

Method Detail

getChildrenProvider

@Nonnull
public IChildrenProvider<CHILDTYPE> getChildrenProvider()

Returns:

The children provider as passed in the constructor. Never null.

getCallback

@Nonnull
public IHierarchyVisitorCallback<? super CHILDTYPE> getCallback()

Returns:

The callback to be executed as passed in the constructor. Never null.

visit

public void visit(@Nullable
         CHILDTYPE aStartObject,
         boolean bInvokeOnStartObject)

Description copied from interface: IHierarchyVisitor

Visit all objects, starting specified one.

Specified by:

visit in interface IHierarchyVisitor<CHILDTYPE>

Parameters:

aStartObject - The object to start from. May be null to indicate the hierarchy root.

bInvokeOnStartObject - true to indicate that the callback should also be invoked on the first element, false to indicate that the callback should only be invoked for the children of the passed element.

visitAll

public static <CHILDTYPE extends IHasChildren<CHILDTYPE>> void visitAll(@Nonnull
                                                        IHierarchyVisitorCallback<? super CHILDTYPE> aCallback,
                                                        boolean bInvokeOnStartObject)

visitAll

public static <CHILDTYPE> void visitAll(@Nonnull
                        IChildrenProvider<CHILDTYPE> aChildrenProvider,
                        @Nonnull
                        IHierarchyVisitorCallback<? super CHILDTYPE> aCallback,
                        boolean bInvokeOnStartObject)

visitFrom

public static <CHILDTYPE extends IHasChildren<CHILDTYPE>> void visitFrom(@Nullable
                                                         CHILDTYPE aStartObject,
                                                         @Nonnull
                                                         IHierarchyVisitorCallback<? super CHILDTYPE> aCallback,
                                                         boolean bInvokeOnStartObject)

visitFrom

public static <CHILDTYPE> void visitFrom(@Nullable
                         CHILDTYPE aStartObject,
                         @Nonnull
                         IChildrenProvider<CHILDTYPE> aChildrenProvider,
                         @Nonnull
                         IHierarchyVisitorCallback<? super CHILDTYPE> aCallback,
                         boolean bInvokeOnStartObject)