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 */
28 public interface ExecutionEvent {
29
30 /**
31 * The possible types of execution events.
32 *
33 * Note: do not modify this enum, or, make sure that this enum and
34 * {@link org.apache.maven.api.EventType} have same elements in same order.
35 */
36 enum Type {
37 ProjectDiscoveryStarted,
38 SessionStarted,
39 SessionEnded,
40 ProjectSkipped,
41 ProjectStarted,
42 ProjectSucceeded,
43 ProjectFailed,
44 MojoSkipped,
45 MojoStarted,
46 MojoSucceeded,
47 MojoFailed,
48 ForkStarted,
49 ForkSucceeded,
50 ForkFailed,
51 ForkedProjectStarted,
52 ForkedProjectSucceeded,
53 ForkedProjectFailed,
54 }
55
56 /**
57 * Gets the type of the event.
58 *
59 * @return The type of the event, never {@code null}.
60 */
61 Type getType();
62
63 /**
64 * Gets the session from which this event originates.
65 *
66 * @return The current session, never {@code null}.
67 */
68 MavenSession getSession();
69
70 /**
71 * Gets the current project (if any).
72 *
73 * @return The current project or {@code null} if not applicable.
74 */
75 MavenProject getProject();
76
77 /**
78 * Gets the current mojo execution (if any).
79 *
80 * @return The current mojo execution or {@code null} if not applicable.
81 */
82 MojoExecution getMojoExecution();
83
84 /**
85 * Gets the exception that caused the event (if any).
86 *
87 * @return The exception or {@code null} if none.
88 */
89 Exception getException();
90 }