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