SCM-Manager/scm-webapp/src/main/java/sonia/scm/plugin/StringDependencyGraphDumper.java

/**
 * Copyright (c) 2010, Sebastian Sdorra
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. Neither the name of SCM-Manager; nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * http://bitbucket.org/sdorra/scm-manager
 *
 */


package sonia.scm.plugin;

//~--- non-JDK imports --------------------------------------------------------

import org.sonatype.aether.graph.DependencyNode;
import org.sonatype.aether.graph.DependencyVisitor;

/**
 *
 * @author Sebastian Sdorra
 */
public class StringDependencyGraphDumper implements DependencyVisitor
{

  /** Field description */
  private static final String LINE_SEPARATOR = System.getProperty("line.separator");

  //~--- methods --------------------------------------------------------------

  /**
   * Method description
   *
   */
  public void reset()
  {
    buffer = new StringBuilder();
  }

  /**
   * Method description
   *
   *
   * @param node
   *
   * @return
   */
  @Override
  public boolean visitEnter(DependencyNode node)
  {
    buffer.append(currentIndent).append(node).append(LINE_SEPARATOR);

    if (currentIndent.length() <= 0)
    {
      currentIndent = "+- ";
    }
    else
    {
      currentIndent = "|  " + currentIndent;
    }

    return true;
  }

  /**
   * Method description
   *
   *
   * @param node
   *
   * @return
   */
  @Override
  public boolean visitLeave(DependencyNode node)
  {
    currentIndent = currentIndent.substring(3, currentIndent.length());

    return true;
  }

  //~--- get methods ----------------------------------------------------------

  /**
   * Method description
   *
   *
   * @return
   */
  public String getGraphAsString()
  {
    return buffer.toString();
  }

  //~--- fields ---------------------------------------------------------------

  /** Field description */
  private StringBuilder buffer = new StringBuilder();

  /** Field description */
  private String currentIndent = "";
}