View Javadoc

1   package org.apache.maven.repository.metadata;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.artifact.ArtifactScopeEnum;
23  
24  /**
25   * Resolves conflicts in the supplied dependency graph.
26   * Different implementations will implement different conflict resolution policies.
27   *
28   * @author <a href="mailto:oleg@codehaus.org">Oleg Gusakov</a>
29   * @version $Id: GraphConflictResolver.java 958295 2010-06-26 23:16:18Z hboutemy $
30   */
31  public interface GraphConflictResolver
32  {
33      String ROLE = GraphConflictResolver.class.getName();
34  
35      /**
36       * Cleanses the supplied graph by leaving only one directed versioned edge\
37       * between any two nodes, if multiple exists. Uses scope relationships, defined
38       * in <code>ArtifactScopeEnum</code>
39       *
40       * @param graph the "dirty" graph to be simplified via conflict resolution
41       * @param scope scope for which the graph should be resolved
42       *
43       * @return resulting "clean" graph for the specified scope
44       *
45       * @since 3.0
46       */
47      MetadataGraph resolveConflicts( MetadataGraph graph, ArtifactScopeEnum scope )
48          throws GraphConflictResolutionException;
49  }