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