com.phloc.commons.hierarchy.IHierarchyWalkerDynamicCallback Maven / Gradle / Ivy
/**
* Copyright (C) 2006-2015 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.phloc.commons.hierarchy;
import javax.annotation.Nonnull;
/**
* Interface for walking a hierarchy including possibilities to alter they way
* how the hierarchy is iterated.
*
* @author Philip Helger
* @param
* The type of object to be iterated.
*/
public interface IHierarchyWalkerDynamicCallback extends IBaseHierarchyWalker
{
/**
* Called before eventual children of the current item are iterated.
*
* @param aItem
* The current item. May be null.
* @return A non-null status code that determines how to continue
* iteration.
*/
@Nonnull
EHierarchyCallbackReturn onItemBeforeChildren (DATATYPE aItem);
/**
* Called after eventual children of the current item were iterated.
*
* @param aItem
* The current item. May be null.
* @return A non-null status code that determines how to continue
* iteration.
*/
@Nonnull
EHierarchyCallbackReturn onItemAfterChildren (DATATYPE aItem);
}