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.plugin;
20
21 import org.apache.maven.api.annotations.Consumer;
22 import org.apache.maven.api.annotations.Experimental;
23 import org.apache.maven.api.annotations.ThreadSafe;
24
25 /**
26 * This interface forms the contract required for Mojos to interact with the Maven infrastructure.
27 * It features an {@link #execute()} method, which triggers the Mojo's build-process behavior,
28 * and can throw a {@link MojoException} if error conditions occur.
29 *
30 * @since 4.0.0
31 */
32 @Experimental
33 @FunctionalInterface
34 @Consumer
35 @ThreadSafe
36 public interface Mojo {
37 /**
38 * Perform whatever build-process behavior this {@code Mojo} implements.
39 * This is the main trigger for the {@code Mojo} inside the Maven system,
40 * and allows the {@code Mojo} to communicate errors.
41 *
42 * @throws MojoException if a problem occurs
43 */
44 void execute();
45 }