View Javadoc

1   package org.apache.maven.execution;
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 java.util.List;
23  
24  import org.apache.maven.project.DependencyResolutionResult;
25  import org.apache.maven.project.MavenProject;
26  
27  /**
28   * @author Jason van Zyl
29   */
30  public interface MavenExecutionResult
31  {
32      MavenExecutionResult setProject( MavenProject project );
33      MavenProject getProject();
34  
35      MavenExecutionResult setTopologicallySortedProjects( List<MavenProject> projects );
36      
37      /**
38       * @return the sorted list, or an empty list if there are no projects.
39       */
40      List<MavenProject> getTopologicallySortedProjects();
41  
42      MavenExecutionResult setDependencyResolutionResult( DependencyResolutionResult result );
43      DependencyResolutionResult getDependencyResolutionResult();
44  
45      // for each exception
46      // - knowing what artifacts are missing
47      // - project building exception
48      // - invalid project model exception: list of markers
49      // - xmlpull parser exception
50      List<Throwable> getExceptions();
51  
52      MavenExecutionResult addException( Throwable e );
53  
54      boolean hasExceptions();
55  
56      /**
57       * Gets the build summary for the specified project.
58       *
59       * @param project The project to get the build summary for, must not be {@code null}.
60       * @return The build summary for the project or {@code null} if the project has not been built (yet).
61       */
62      BuildSummary getBuildSummary( MavenProject project );
63  
64      /**
65       * Add the specified build summary.
66       *
67       * @param summary The build summary to add, must not be {@code null}.
68       */
69      void addBuildSummary( BuildSummary summary );
70  
71  }