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.api;
20
21 import java.util.Optional;
22 import org.apache.maven.api.annotations.Experimental;
23 import org.apache.maven.api.annotations.Nonnull;
24
25 /**
26 * Event sent by maven during various phases of the build process.
27 * Such events can be listened to using {@link Listener}s objects
28 * registered in the {@link Session}.
29 *
30 * @since 4.0
31 */
32 @Experimental
33 public interface Event {
34
35 /**
36 * Gets the type of the event.
37 *
38 * @return the type of the event, never {@code null}
39 */
40 @Nonnull
41 EventType getType();
42
43 /**
44 * Gets the session from which this event originates.
45 *
46 * @return the current session, never {@code null}
47 */
48 @Nonnull
49 Session getSession();
50
51 /**
52 * Gets the current project (if any).
53 *
54 * @return the current project or {@code empty()} if not applicable
55 */
56 @Nonnull
57 Optional<Project> getProject();
58
59 /**
60 * Gets the current mojo execution (if any).
61 *
62 * @return the current mojo execution or {@code empty()} if not applicable
63 */
64 @Nonnull
65 Optional<MojoExecution> getMojoExecution();
66
67 /**
68 * Gets the exception that caused the event (if any).
69 *
70 * @return the exception or {@code empty()} if none
71 */
72 Optional<Exception> getException();
73 }