View Javadoc

1   package org.apache.maven.jelly.tags.maven;
2   
3   /* ====================================================================
4    *   Licensed to the Apache Software Foundation (ASF) under one or more
5    *   contributor license agreements.  See the NOTICE file distributed with
6    *   this work for additional information regarding copyright ownership.
7    *   The ASF licenses this file to You under the Apache License, Version 2.0
8    *   (the "License"); you may not use this file except in compliance with
9    *   the License.  You may obtain a copy of the License at
10   *
11   *       http://www.apache.org/licenses/LICENSE-2.0
12   *
13   *   Unless required by applicable law or agreed to in writing, software
14   *   distributed under the License is distributed on an "AS IS" BASIS,
15   *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   *   See the License for the specific language governing permissions and
17   *   limitations under the License.
18   * ====================================================================
19   */
20  
21  import java.util.List;
22  
23  import org.apache.maven.project.Project;
24  
25  /**
26   * @author <a href="mailto:bwalding@apache.org">Ben Walding</a>
27   * @version $Id: DependencyResolverInterface.java 517014 2007-03-11 21:15:50Z ltheussl $
28   */
29  public interface DependencyResolverInterface
30  {
31      /**
32       * Clear the project list and set the graph built flag to false.
33       */
34      void clear();
35  
36      /**
37       * Set a list of projects to process.
38       *
39       * @param projects List of projects.
40       */
41      void setProjects( List projects );
42  
43      /**
44       * Get the list of projects in dependency sorted order.
45       *
46       * @param project The project to use as the head of the graph.
47       * @return The list of projects.
48       * @throws DependencyResolverException If an error occurs while processing the graph.
49       */
50      List getSortedDependencies( Project project )
51          throws DependencyResolverException;
52  
53      /**
54       * Get the list of projects in dependency sorted order.
55       *
56       * @param project     The project to use as the head of the graph.
57       * @param sourceBuild Indicate we are performing a source build.
58       * @return The list of projects.
59       * @throws DependencyResolverException If an error occurs while processing the graph.
60       */
61      List getSortedDependencies( Project project, boolean sourceBuild )
62          throws DependencyResolverException;
63  
64      /**
65       * Get the list of projects in dependency sorted order.
66       *
67       * @param sourceBuild Flag to indicate we are performing a source build.
68       * @return The list of projects.
69       * @throws DependencyResolverException If an error occurs while processing the graph.
70       */
71      List getSortedDependencies( boolean sourceBuild )
72          throws DependencyResolverException;
73  }