View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.repository.metadata;
20  
21  import org.apache.maven.artifact.ArtifactScopeEnum;
22  
23  /**
24   * Helper class to conver an Md Graph into some form of a classpath
25   *
26   * @author <a href="oleg@codehaus.org">Oleg Gusakov</a>
27   *
28   */
29  public interface ClasspathTransformation {
30      String ROLE = ClasspathTransformation.class.getName();
31  
32      /**
33       * Transform Graph into a Collection of metadata objects that
34       * could serve as a classpath for a particular scope
35       *
36       * @param dirtyGraph - dependency graph
37       * @param scope - which classpath to extract
38       * @param resolve - whether to resolve artifacts.
39       * @return Collection of metadata objects in the linked subgraph of the graph which
40       *             contains the graph.getEntry() vertice
41       */
42      ClasspathContainer transform(MetadataGraph dirtyGraph, ArtifactScopeEnum scope, boolean resolve)
43              throws MetadataGraphTransformationException;
44  }