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   * 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   *
31   * @see ProjectExecutionListener
32   * @since 3.1.2
33   * @provisional This class is part of work in progress and can be changed or removed without notice.
34   */
35  public class ProjectExecutionEvent
36  {
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      {
48          this( session, project, null, null );
49      }
50  
51      public ProjectExecutionEvent( MavenSession session, MavenProject project, List<MojoExecution> executionPlan )
52      {
53          this( session, project, executionPlan, null );
54      }
55  
56      public ProjectExecutionEvent( MavenSession session, MavenProject project, Throwable cause )
57      {
58          this( session, project, null, cause );
59      }
60  
61      public ProjectExecutionEvent( MavenSession session, MavenProject project, List<MojoExecution> executionPlan,
62                                    Throwable cause )
63      {
64          this.session = session;
65          this.project = project;
66          this.executionPlan = executionPlan;
67          this.cause = cause;
68      }
69  
70      public MavenSession getSession()
71      {
72          return session;
73      }
74  
75      public MavenProject getProject()
76      {
77          return project;
78      }
79  
80      public List<MojoExecution> getExecutionPlan()
81      {
82          return executionPlan;
83      }
84  
85      public Throwable getCause()
86      {
87          return cause;
88      }
89  
90  }