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 org.apache.maven.plugin.Mojo;
23  import org.apache.maven.plugin.MojoExecution;
24  import org.apache.maven.project.MavenProject;
25  
26  /**
27   * Encapsulates parameters of MojoExecutionListener callback methods and is meant to provide API evolution path should
28   * it become necessary to introduce new parameters in the existing callbacks in the future.
29   *
30   * @see MojoExecutionListener
31   * @see org.apache.maven.execution.scope.WeakMojoExecutionListener
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 MojoExecutionEvent
36  {
37      private final MavenSession session;
38  
39      private final MavenProject project;
40  
41      private final MojoExecution mojoExecution;
42  
43      private final Mojo mojo;
44  
45      private final Throwable cause;
46  
47      public MojoExecutionEvent( MavenSession session, MavenProject project, MojoExecution mojoExecution, Mojo mojo )
48      {
49          this( session, project, mojoExecution, mojo, null );
50      }
51  
52      public MojoExecutionEvent( MavenSession session, MavenProject project, MojoExecution mojoExecution, Mojo mojo,
53                                 Throwable cause )
54      {
55          this.session = session;
56          this.project = project;
57          this.mojoExecution = mojoExecution;
58          this.mojo = mojo;
59          this.cause = cause;
60      }
61  
62      public MavenSession getSession()
63      {
64          return session;
65      }
66  
67      public MavenProject getProject()
68      {
69          return project;
70      }
71  
72      public MojoExecution getExecution()
73      {
74          return mojoExecution;
75      }
76  
77      public Mojo getMojo()
78      {
79          return mojo;
80      }
81  
82      public Throwable getCause()
83      {
84          return cause;
85      }
86  }