com.helger.commons.hierarchy.visit.IHierarchyVisitor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation

Java 1.8+ Library with tons of utility classes required in all projects

There is a newer version: 11.1.10

/*
 * Copyright (C) 2014-2022 Philip Helger (www.helger.com)
 * philip[at]helger[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.helger.commons.hierarchy.visit;

import javax.annotation.Nullable;

/**
 * Visitor interface
 *
 * @author Philip Helger
 * @param 
 *        The data type to be visited
 */
@FunctionalInterface
public interface IHierarchyVisitor 
{
  /**
   * Visit all objects, starting specified one.
   *
   * @param aStartObject
   *        The object to start from. May be null to indicate the
   *        hierarchy root.
   * @param 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.
   */
  void visit (@Nullable DATATYPE aStartObject, boolean bInvokeOnStartObject);
}