org.jvnet.maven.plugin.antrun
Class DependencyGraph.Node

java.lang.Object
  extended by org.jvnet.maven.plugin.antrun.DependencyGraph.Node
Enclosing class:
DependencyGraph

public static final class DependencyGraph.Node
extends Object

Node, which represents an artifact.

A single DependencyGraph.Node can be used in multiple DependencyGraph objects, so the graph traversal method all takes DependencyGraph object to determine the context in which the operation works.


Field Summary
 String artifactId
          Basic properties of a module.
 String classifier
          Basic properties of a module.
 String groupId
          Basic properties of a module.
 String type
          Basic properties of a module.
 String version
          Basic properties of a module.
 
Method Summary
 boolean equals(Object o)
           
 File getArtifactFile()
          Gets the artifact file, like a jar.
 List<DependencyGraph.Edge> getBackwardEdges(DependencyGraph g)
          Gets the backward dependency edges (modules that depend on this module.)
 List<DependencyGraph.Node> getBackwardNodes(DependencyGraph g)
          Gets the nodes that depend on the given node.
 List<DependencyGraph.Edge> getForwardEdges(DependencyGraph g)
          Gets the forward dependency edges (modules that this module depends on.)
 List<DependencyGraph.Node> getForwardNodes(DependencyGraph g)
          Gets the nodes that the given node depends on.
 String getId()
           
 org.apache.maven.project.MavenProject getProject()
          Gets the parsed POM for this artifact.
 List<DependencyGraph.Edge> getTrail(DependencyGraph graph)
          Builds the dependency trail from this node to the root node, in that order.
 int hashCode()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

groupId

public final String groupId
Basic properties of a module. If pom is non-null, this information is redundant, but it needs to be kept separately for those rare cases where pom==null.


artifactId

public final String artifactId
Basic properties of a module. If pom is non-null, this information is redundant, but it needs to be kept separately for those rare cases where pom==null.


version

public final String version
Basic properties of a module. If pom is non-null, this information is redundant, but it needs to be kept separately for those rare cases where pom==null.


type

public final String type
Basic properties of a module. If pom is non-null, this information is redundant, but it needs to be kept separately for those rare cases where pom==null.


classifier

public final String classifier
Basic properties of a module. If pom is non-null, this information is redundant, but it needs to be kept separately for those rare cases where pom==null.

Method Detail

getProject

public org.apache.maven.project.MavenProject getProject()
Gets the parsed POM for this artifact.

Returns:
null if POM is not available for this module. That can happen for example for system-scoped artifacts.

getArtifactFile

public File getArtifactFile()
                     throws org.apache.maven.artifact.resolver.AbstractArtifactResolutionException
Gets the artifact file, like a jar.

Returns:
for system-scoped artifacts, this may null. If this node represents the current module being built, this field may or may not be null, depending on whether the artifact is already created in the current build or not. For all the other modules, this is never null.
Throws:
org.apache.maven.artifact.resolver.AbstractArtifactResolutionException - Failed to resolve artifacat.

getForwardEdges

public List<DependencyGraph.Edge> getForwardEdges(DependencyGraph g)
Gets the forward dependency edges (modules that this module depends on.)


getBackwardEdges

public List<DependencyGraph.Edge> getBackwardEdges(DependencyGraph g)
Gets the backward dependency edges (modules that depend on this module.)


getForwardNodes

public List<DependencyGraph.Node> getForwardNodes(DependencyGraph g)
Gets the nodes that the given node depends on.


getBackwardNodes

public List<DependencyGraph.Node> getBackwardNodes(DependencyGraph g)
Gets the nodes that depend on the given node.


toString

public String toString()
Overrides:
toString in class Object

getId

public String getId()

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

getTrail

public List<DependencyGraph.Edge> getTrail(DependencyGraph graph)
Builds the dependency trail from this node to the root node, in that order. This is useful as diagnostic information.



Copyright © 2011. All Rights Reserved.