com.helger.commons.tree.util

Class TreeVisitor.HierarchyVisitorCallbackWithConversion<ITEMTYPE,DATATYPE>

java.lang.Object

com.helger.commons.hierarchy.visit.DefaultHierarchyVisitorCallback<ITEMTYPE>

com.helger.commons.tree.util.TreeVisitor.HierarchyVisitorCallbackWithConversion<ITEMTYPE,DATATYPE>

All Implemented Interfaces:

ICallback, IHierarchyVisitorCallback<ITEMTYPE>, Serializable

Enclosing class:

TreeVisitor

public static class TreeVisitor.HierarchyVisitorCallbackWithConversion<ITEMTYPE,DATATYPE>
extends DefaultHierarchyVisitorCallback<ITEMTYPE>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TreeVisitor.HierarchyVisitorCallbackWithConversion(IHierarchyVisitorCallback<? super DATATYPE> aDataCallback, IConverter<ITEMTYPE,DATATYPE> aConverter)

Method Summary

Methods

Modifier and Type	Method and Description
void	begin() Called before the tree walking starts.
void	end() Called after the tree walking ended.
EHierarchyVisitorReturn	onItemAfterChildren(ITEMTYPE aItem) Called after eventual children of the current item were visited.
EHierarchyVisitorReturn	onItemBeforeChildren(ITEMTYPE aItem) Called before children of the current item are visited.
void	onLevelDown() Called before the tree walker descends into the next tree level.
void	onLevelUp() Called after the tree walker ascends into the previous tree level.

Methods inherited from class com.helger.commons.hierarchy.visit.DefaultHierarchyVisitorCallback

getLevel

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeVisitor.HierarchyVisitorCallbackWithConversion

public TreeVisitor.HierarchyVisitorCallbackWithConversion(@Nonnull
                                                  IHierarchyVisitorCallback<? super DATATYPE> aDataCallback,
                                                  @Nonnull
                                                  IConverter<ITEMTYPE,DATATYPE> aConverter)

Method Detail

begin

public void begin()

Description copied from interface: IHierarchyVisitorCallback

Called before the tree walking starts.

Specified by:

begin in interface IHierarchyVisitorCallback<ITEMTYPE>

Overrides:

begin in class DefaultHierarchyVisitorCallback<ITEMTYPE>

onLevelDown

public void onLevelDown()

Description copied from interface: IHierarchyVisitorCallback

Called before the tree walker descends into the next tree level. After this call IHierarchyVisitorCallback.getLevel() should return a value increased by 1.

Specified by:

onLevelDown in interface IHierarchyVisitorCallback<ITEMTYPE>

Overrides:

onLevelDown in class DefaultHierarchyVisitorCallback<ITEMTYPE>

onLevelUp

public void onLevelUp()

Description copied from interface: IHierarchyVisitorCallback

Called after the tree walker ascends into the previous tree level. After this call IHierarchyVisitorCallback.getLevel() should return a value decreased by 1.

Specified by:

onLevelUp in interface IHierarchyVisitorCallback<ITEMTYPE>

Overrides:

onLevelUp in class DefaultHierarchyVisitorCallback<ITEMTYPE>

onItemBeforeChildren

@Nonnull
public EHierarchyVisitorReturn onItemBeforeChildren(@Nonnull
                                                   ITEMTYPE aItem)

Description copied from interface: IHierarchyVisitorCallback

Called before children of the current item are visited. This method is also to be called if no children are present at all.

Specified by:

onItemBeforeChildren in interface IHierarchyVisitorCallback<ITEMTYPE>

Overrides:

onItemBeforeChildren in class DefaultHierarchyVisitorCallback<ITEMTYPE>

Parameters:

aItem - The current item. May be null.

Returns:

A non-null status code that determines how to continue iteration.

onItemAfterChildren

@Nonnull
public EHierarchyVisitorReturn onItemAfterChildren(@Nonnull
                                                  ITEMTYPE aItem)

Description copied from interface: IHierarchyVisitorCallback

Called after eventual children of the current item were visited. This method is also to be called if no children are present at all. This method has always to be called if IHierarchyVisitorCallback.onItemBeforeChildren(Object) was called.

Specified by:

onItemAfterChildren in interface IHierarchyVisitorCallback<ITEMTYPE>

Overrides:

onItemAfterChildren in class DefaultHierarchyVisitorCallback<ITEMTYPE>

Parameters:

aItem - The current item. May be null.

Returns:

A non-null status code that determines how to continue iteration.

end

public void end()

Description copied from interface: IHierarchyVisitorCallback

Called after the tree walking ended.

Specified by:

end in interface IHierarchyVisitorCallback<ITEMTYPE>

Overrides:

end in class DefaultHierarchyVisitorCallback<ITEMTYPE>