001    package org.apache.maven.repository.metadata;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *  http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    import org.apache.maven.artifact.ArtifactScopeEnum;
023    
024    /**
025     * Helper class to conver an Md Graph into some form of a classpath
026     *
027     * @author <a href="oleg@codehaus.org">Oleg Gusakov</a>
028     *
029     */
030    public interface ClasspathTransformation
031    {
032        String ROLE = ClasspathTransformation.class.getName();
033    
034        /**
035         * Transform Graph into a Collection of metadata objects that
036         * could serve as a classpath for a particular scope
037         *
038         * @param dirtyGraph - dependency graph
039         * @param scope - which classpath to extract
040         * @param resolve - whether to resolve artifacts.
041         * @return Collection of metadata objects in the linked subgraph of the graph which
042         *             contains the graph.getEntry() vertice
043         */
044        ClasspathContainer transform( MetadataGraph dirtyGraph, ArtifactScopeEnum scope, boolean resolve )
045            throws MetadataGraphTransformationException;
046    }