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.execution.scope.WeakMojoExecutionListener;
23  import org.apache.maven.plugin.Mojo;
24  import org.apache.maven.plugin.MojoExecution;
25  import org.apache.maven.project.MavenProject;
26  
27  /**
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   * 
31   * @see MojoExecutionListener
32   * @see WeakMojoExecutionListener
33   * @since 3.1.2
34   * @provisional This class is part of work in progress and can be changed or removed without notice.
35   */
36  public class MojoExecutionEvent
37  {
38      private final MavenSession session;
39  
40      private final MavenProject project;
41  
42      private final MojoExecution mojoExecution;
43  
44      private final Mojo mojo;
45  
46      private final Throwable cause;
47  
48      public MojoExecutionEvent( MavenSession session, MavenProject project, MojoExecution mojoExecution, Mojo mojo )
49      {
50          this( session, project, mojoExecution, mojo, null );
51      }
52  
53      public MojoExecutionEvent( MavenSession session, MavenProject project, MojoExecution mojoExecution, Mojo mojo,
54                                 Throwable cause )
55      {
56          this.session = session;
57          this.project = project;
58          this.mojoExecution = mojoExecution;
59          this.mojo = mojo;
60          this.cause = cause;
61      }
62  
63      public MavenSession getSession()
64      {
65          return session;
66      }
67  
68      public MavenProject getProject()
69      {
70          return project;
71      }
72  
73      public MojoExecution getExecution()
74      {
75          return mojoExecution;
76      }
77  
78      public Mojo getMojo()
79      {
80          return mojo;
81      }
82  
83      public Throwable getCause()
84      {
85          return cause;
86      }
87  }