1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.execution;
20
21 import org.apache.maven.plugin.MojoExecution;
22 import org.apache.maven.project.MavenProject;
23
24 /**
25 * Holds data relevant for an execution event.
26 *
27 * @author Benjamin Bentmann
28 */
29 public interface ExecutionEvent {
30
31 /**
32 * The possible types of execution events.
33 */
34 enum Type {
35 ProjectDiscoveryStarted,
36 SessionStarted,
37 SessionEnded,
38 ProjectSkipped,
39 ProjectStarted,
40 ProjectSucceeded,
41 ProjectFailed,
42 MojoSkipped,
43 MojoStarted,
44 MojoSucceeded,
45 MojoFailed,
46 ForkStarted,
47 ForkSucceeded,
48 ForkFailed,
49 ForkedProjectStarted,
50 ForkedProjectSucceeded,
51 ForkedProjectFailed,
52 }
53
54 /**
55 * Gets the type of the event.
56 *
57 * @return The type of the event, never {@code null}.
58 */
59 Type getType();
60
61 /**
62 * Gets the session from which this event originates.
63 *
64 * @return The current session, never {@code null}.
65 */
66 MavenSession getSession();
67
68 /**
69 * Gets the current project (if any).
70 *
71 * @return The current project or {@code null} if not applicable.
72 */
73 MavenProject getProject();
74
75 /**
76 * Gets the current mojo execution (if any).
77 *
78 * @return The current mojo execution or {@code null} if not applicable.
79 */
80 MojoExecution getMojoExecution();
81
82 /**
83 * Gets the exception that caused the event (if any).
84 *
85 * @return The exception or {@code null} if none.
86 */
87 Exception getException();
88 }