com.phloc.commons.hierarchy

Class DefaultHierarchyWalker

java.lang.Object

com.phloc.commons.hierarchy.DefaultHierarchyWalker

All Implemented Interfaces:

IBaseHierarchyWalker

Direct Known Subclasses:

DefaultHierarchyWalkerCallback, DefaultHierarchyWalkerDynamicCallback

public class DefaultHierarchyWalker
extends Object
implements IBaseHierarchyWalker

The default implementation of the IBaseHierarchyWalker interface.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
DefaultHierarchyWalker()
DefaultHierarchyWalker(int nInitialLevel)

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.
int	getLevel()
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 java.lang.Object

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

Constructor Detail

DefaultHierarchyWalker

public DefaultHierarchyWalker()

DefaultHierarchyWalker

public DefaultHierarchyWalker(int nInitialLevel)

Method Detail

begin

@OverrideOnDemand
public void begin()

Description copied from interface: IBaseHierarchyWalker

Called before the tree walking starts.

Specified by:

begin in interface IBaseHierarchyWalker

onLevelDown

@OverrideOnDemand
@OverridingMethodsMustInvokeSuper
public void onLevelDown()

Description copied from interface: IBaseHierarchyWalker

Called before the tree walker descends into the next tree level.

Specified by:

onLevelDown in interface IBaseHierarchyWalker

getLevel

@Nonnegative
public int getLevel()

Specified by:

getLevel in interface IBaseHierarchyWalker

Returns:

The level of the current node within the tree. The root item has level 0.

onLevelUp

@OverrideOnDemand
@OverridingMethodsMustInvokeSuper
public void onLevelUp()

Description copied from interface: IBaseHierarchyWalker

Called after the tree walker ascends into the previous tree level.

Specified by:

onLevelUp in interface IBaseHierarchyWalker

end

@OverrideOnDemand
public void end()

Description copied from interface: IBaseHierarchyWalker

Called after the tree walking ended.

Specified by:

end in interface IBaseHierarchyWalker