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   * Helper class to conver an Md Graph into some form of a classpath
26   *
27   * @author <a href="oleg@codehaus.org">Oleg Gusakov</a>
28   *
29   */
30  public interface ClasspathTransformation
31  {
32      String ROLE = ClasspathTransformation.class.getName();
33  
34      /**
35       * Transform Graph into a Collection of metadata objects that
36       * could serve as a classpath for a particular scope
37       *
38       * @param dirtyGraph - dependency graph
39       * @param scope - which classpath to extract
40       * @param resolve - whether to resolve artifacts.
41       * @return Collection of metadata objects in the linked subgraph of the graph which
42       *             contains the graph.getEntry() vertice
43       */
44      ClasspathContainer transform( MetadataGraph dirtyGraph, ArtifactScopeEnum scope, boolean resolve )
45          throws MetadataGraphTransformationException;
46  }