com.helger.html.hc.IHCIteratorCallback Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2014-2016 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.html.hc;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.callback.ICallback;
import com.helger.commons.state.EFinish;

/**
 * Callback interface to be used when iterating an HC tree.
 *
 * @author Philip Helger
 */
@FunctionalInterface
public interface IHCIteratorCallback extends ICallback
{
  /**
   * Callback method
   *
   * @param aParentNode
   *        Optional parent node. May be null for the initial
   *        element.
   * @param aChildNode
   *        The current child node. Never null.
   * @return {@link EFinish#FINISHED} to break iteration and
   *         {@link EFinish#UNFINISHED} to continue iteration.
   */
  @Nonnull
  EFinish call (@Nullable IHCNode aParentNode, @Nonnull IHCNode aChildNode);
}