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