]>
git.argeo.org Git - gpl/argeo-slc.git/blob - org.argeo.slc.repo/src/org/eclipse/aether/graph/DependencyCycle.java
1 /*******************************************************************************
2 * Copyright (c) 2013, 2014 Sonatype, Inc.
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the Eclipse Public License v1.0
5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/epl-v10.html
9 * Sonatype, Inc. - initial API and implementation
10 *******************************************************************************/
11 package org
.eclipse
.aether
.graph
;
13 import java
.util
.List
;
16 * A cycle within a dependency graph, that is a sequence of dependencies d_1, d_2, ..., d_n where d_1 and d_n have the
17 * same versionless coordinates. In more practical terms, a cycle occurs when a project directly or indirectly depends
18 * on its own output artifact.
20 * @noimplement This interface is not intended to be implemented by clients.
21 * @noextend This interface is not intended to be extended by clients.
23 public interface DependencyCycle
27 * Gets the dependencies that lead to the first dependency on the cycle, starting from the root of the dependency
30 * @return The (read-only) sequence of dependencies that precedes the cycle in the graph, potentially empty but
33 List
<Dependency
> getPrecedingDependencies();
36 * Gets the dependencies that actually form the cycle. For example, a -> b -> c -> a, i.e. the last
37 * dependency in this sequence duplicates the first element and closes the cycle. Hence the length of the cycle is
38 * the size of the returned sequence minus 1.
40 * @return The (read-only) sequence of dependencies that forms the cycle, never {@code null}.
42 List
<Dependency
> getCyclicDependencies();