org.apache.maven.shared.dependency.tree.traversal
Class SerializingDependencyNodeVisitor

java.lang.Object
  org.apache.maven.shared.dependency.tree.traversal.SerializingDependencyNodeVisitor

All Implemented Interfaces:

DependencyNodeVisitor

public class SerializingDependencyNodeVisitor
extends Object
implements DependencyNodeVisitor

A dependency node visitor that serializes visited nodes to a writer.

Since:

1.1

Version:

$Id: SerializingDependencyNodeVisitor.java 1100703 2011-05-08 08:27:33Z hboutemy $

Author:

Mark Hobson

WHITESPACE_TOKENS

public static final SerializingDependencyNodeVisitor.TreeTokens WHITESPACE_TOKENS

Whitespace tokens to use when outputing the dependency tree.

STANDARD_TOKENS

public static final SerializingDependencyNodeVisitor.TreeTokens STANDARD_TOKENS

The standard ASCII tokens to use when outputing the dependency tree.

EXTENDED_TOKENS

public static final SerializingDependencyNodeVisitor.TreeTokens EXTENDED_TOKENS

The extended ASCII tokens to use when outputing the dependency tree.

SerializingDependencyNodeVisitor

public SerializingDependencyNodeVisitor(Writer writer)

Creates a dependency node visitor that serializes visited nodes to the specified writer using whitespace tokens.

Parameters:

writer - the writer to serialize to

SerializingDependencyNodeVisitor

public SerializingDependencyNodeVisitor(Writer writer,
                                        SerializingDependencyNodeVisitor.TreeTokens tokens)

Creates a dependency node visitor that serializes visited nodes to the specified writer using the specified tokens.

Parameters:

writer - the writer to serialize to

tokens - the tokens to use when serializing the dependency tree

visit

public boolean visit(DependencyNode node)

Starts the visit to the specified dependency node.

Specified by:

visit in interface DependencyNodeVisitor

Parameters:

node - the dependency node to visit

Returns:

true to visit the specified dependency node's children, false to skip the specified dependency node's children and proceed to its next sibling

endVisit

public boolean endVisit(DependencyNode node)

Ends the visit to to the specified dependency node.

Specified by:

endVisit in interface DependencyNodeVisitor

Parameters:

node - the dependency node to visit

Returns:

true to visit the specified dependency node's next sibling, false to skip the specified dependency node's next siblings and proceed to its parent