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.execution;
20  
21  import java.util.List;
22  
23  import org.apache.maven.plugin.MojoExecution;
24  import org.apache.maven.project.MavenProject;
25  
26  /**
27   * <p>
28   * Encapsulates parameters of ProjectExecutionListener callback methods and is meant to provide API evolution path
29   * should it become necessary to introduce new parameters in the existing callbacks in the future.
30   * </p>
31   * <strong>Note:</strong> This class is part of work in progress and can be changed or removed without notice.
32   *
33   * @see ProjectExecutionListener
34   * @since 3.1.2
35   */
36  public class ProjectExecutionEvent {
37  
38      private final MavenSession session;
39  
40      private final MavenProject project;
41  
42      private final List<MojoExecution> executionPlan;
43  
44      private final Throwable cause;
45  
46      public ProjectExecutionEvent(MavenSession session, MavenProject project) {
47          this(session, project, null, null);
48      }
49  
50      public ProjectExecutionEvent(MavenSession session, MavenProject project, List<MojoExecution> executionPlan) {
51          this(session, project, executionPlan, null);
52      }
53  
54      public ProjectExecutionEvent(MavenSession session, MavenProject project, Throwable cause) {
55          this(session, project, null, cause);
56      }
57  
58      public ProjectExecutionEvent(
59              MavenSession session, MavenProject project, List<MojoExecution> executionPlan, Throwable cause) {
60          this.session = session;
61          this.project = project;
62          this.executionPlan = executionPlan;
63          this.cause = cause;
64      }
65  
66      public MavenSession getSession() {
67          return session;
68      }
69  
70      public MavenProject getProject() {
71          return project;
72      }
73  
74      public List<MojoExecution> getExecutionPlan() {
75          return executionPlan;
76      }
77  
78      public Throwable getCause() {
79          return cause;
80      }
81  }