com.helger.xml.microdom.util.MicroVisitor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-xml Show documentation
Java 1.8+ Library with XML handling routines
The newest version!
/*
 * Copyright (C) 2014-2024 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.xml.microdom.util;

import javax.annotation.Nonnull;
import javax.annotation.concurrent.Immutable;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.PresentForCodeCoverage;
import com.helger.commons.hierarchy.IChildrenProvider;
import com.helger.commons.hierarchy.visit.ChildrenProviderHierarchyVisitor;
import com.helger.commons.hierarchy.visit.IHierarchyVisitorCallback;
import com.helger.xml.microdom.IMicroNode;

/**
 * Helper class that visits a {@link com.helger.xml.microdom.IMicroNode} with a
 * callback.
 *
 * @author Philip Helger
 */
@Immutable
public final class MicroVisitor
{
  @PresentForCodeCoverage
  private static final MicroVisitor INSTANCE = new MicroVisitor ();

  private MicroVisitor ()
  {}

  /**
   * Iterate the passed node and invoke the callback for all child nodes. The
   * callback is not invoked for the passed node itself!
   *
   * @param aNode
   *        The node to iterate. May not be null.
   * @param aCallback
   *        The callback to call. May not be null.
   */
  public static void visit (@Nonnull final IMicroNode aNode, @Nonnull final IHierarchyVisitorCallback  aCallback)
  {
    ValueEnforcer.notNull (aNode, "Node");
    ChildrenProviderHierarchyVisitor.visitFrom (aNode, aCallback, false);
  }

  /**
   * Iterate the passed node and invoke the callback for all child nodes. The
   * callback is not invoked for the passed node itself!
   *
   * @param 
   *        The node type to be visited
   * @param aNode
   *        The node to iterate. May not be null.
   * @param aChildrenProvider
   *        The child resolver to use. May not be null.
   * @param aCallback
   *        The callback to call. May not be null.
   */
  public static  void visit (@Nonnull final T aNode,
                                                   @Nonnull final IChildrenProvider  aChildrenProvider,
                                                   @Nonnull final IHierarchyVisitorCallback  aCallback)
  {
    ValueEnforcer.notNull (aNode, "Node");
    ChildrenProviderHierarchyVisitor.visitFrom (aNode, aChildrenProvider, aCallback, false);
  }
}