org.apache.maven.graph

Class DefaultProjectDependencyGraph

java.lang.Object

org.apache.maven.graph.DefaultProjectDependencyGraph

All Implemented Interfaces:

ProjectDependencyGraph

public class DefaultProjectDependencyGraph
extends java.lang.Object
implements ProjectDependencyGraph

Describes the inter-dependencies between projects in the reactor.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<MavenProject>	allProjects
private ProjectSorter	sorter

Constructor Summary

Constructors

Constructor and Description
DefaultProjectDependencyGraph(java.util.Collection<MavenProject> projects) Creates a new project dependency graph based on the specified projects.
DefaultProjectDependencyGraph(java.util.List<MavenProject> allProjects, java.util.Collection<MavenProject> projects) Creates a new project dependency graph based on the specified projects.

Method Summary

Modifier and Type	Method and Description
java.util.List<MavenProject>	getAllProjects() Gets all collected projects.
java.util.List<MavenProject>	getDownstreamProjects(MavenProject project, boolean transitive) Gets the downstream projects of the specified project.
private void	getDownstreamProjects(java.lang.String projectId, java.util.Set<java.lang.String> projectIds, boolean transitive)
java.util.List<MavenProject>	getSortedProjects() Gets all projects in their intended build order, i.e.
private java.util.List<MavenProject>	getSortedProjects(java.util.Set<java.lang.String> projectIds)
java.util.List<MavenProject>	getUpstreamProjects(MavenProject project, boolean transitive) Gets the upstream projects of the specified project.
private void	getUpstreamProjects(java.lang.String projectId, java.util.Collection<java.lang.String> projectIds, boolean transitive)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sorter

private ProjectSorter sorter

allProjects

private java.util.List<MavenProject> allProjects

Constructor Detail

DefaultProjectDependencyGraph

public DefaultProjectDependencyGraph(java.util.Collection<MavenProject> projects)
                              throws org.codehaus.plexus.util.dag.CycleDetectedException,
                                     DuplicateProjectException

Creates a new project dependency graph based on the specified projects.

Parameters:

projects - The projects to create the dependency graph with

Throws:

DuplicateProjectException

org.codehaus.plexus.util.dag.CycleDetectedException

DefaultProjectDependencyGraph

public DefaultProjectDependencyGraph(java.util.List<MavenProject> allProjects,
                                     java.util.Collection<MavenProject> projects)
                              throws org.codehaus.plexus.util.dag.CycleDetectedException,
                                     DuplicateProjectException

Creates a new project dependency graph based on the specified projects.

Parameters:

allProjects - All collected projects.

projects - The projects to create the dependency graph with.

Throws:

DuplicateProjectException

org.codehaus.plexus.util.dag.CycleDetectedException

Since:

3.5.0

Method Detail

getAllProjects

public java.util.List<MavenProject> getAllProjects()

Description copied from interface: ProjectDependencyGraph

Gets all collected projects.

Specified by:

getAllProjects in interface ProjectDependencyGraph

Returns:

All collected projects.

Since:

3.5.0

getSortedProjects

public java.util.List<MavenProject> getSortedProjects()

Description copied from interface: ProjectDependencyGraph

Gets all projects in their intended build order, i.e. after topologically sorting the projects according to their inter-dependencies.

Specified by:

getSortedProjects in interface ProjectDependencyGraph

Returns:

The projects in the build order, never null.

getDownstreamProjects

public java.util.List<MavenProject> getDownstreamProjects(MavenProject project,
                                                          boolean transitive)

Description copied from interface: ProjectDependencyGraph

Gets the downstream projects of the specified project. A downstream project is a project that directly or indirectly depends on the given project.

Specified by:

getDownstreamProjects in interface ProjectDependencyGraph

Parameters:

project - The project whose downstream projects should be retrieved, must not be null.

transitive - A flag whether to retrieve all direct and indirect downstream projects or just the immediate downstream projects.

Returns:

The downstream projects in the build order, never null.

getDownstreamProjects

private void getDownstreamProjects(java.lang.String projectId,
                                   java.util.Set<java.lang.String> projectIds,
                                   boolean transitive)

getUpstreamProjects

public java.util.List<MavenProject> getUpstreamProjects(MavenProject project,
                                                        boolean transitive)

Description copied from interface: ProjectDependencyGraph

Gets the upstream projects of the specified project. An upstream project is a project that directly or indirectly is a prerequisite of the given project.

Specified by:

getUpstreamProjects in interface ProjectDependencyGraph

Parameters:

project - The project whose upstream projects should be retrieved, must not be null.

transitive - A flag whether to retrieve all direct and indirect upstream projects or just the immediate upstream projects.

Returns:

The upstream projects in the build order, never null.

getUpstreamProjects

private void getUpstreamProjects(java.lang.String projectId,
                                 java.util.Collection<java.lang.String> projectIds,
                                 boolean transitive)

getSortedProjects

private java.util.List<MavenProject> getSortedProjects(java.util.Set<java.lang.String> projectIds)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object