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