1 package org.apache.maven.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.plugin.logging.Log;
23
24 /**
25 * This interface forms the contract required for <code>Mojos</code> to interact with the <code>Maven</code>
26 * infrastructure.<br>
27 * It features an <code>execute()</code> method, which triggers the Mojo's build-process behavior, and can throw
28 * a MojoExecutionException or MojoFailureException if error conditions occur.<br>
29 * Also included is the <code>setLog(...)</code> method, which simply allows Maven to inject a logging mechanism which
30 * will allow the Mojo to communicate to the outside world through standard Maven channels.
31 *
32 * @author Jason van Zyl
33 */
34 public interface Mojo
35 {
36 /** The component <code>role</code> hint for Plexus container */
37 String ROLE = Mojo.class.getName();
38
39 /**
40 * Perform whatever build-process behavior this <code>Mojo</code> implements.<br>
41 * This is the main trigger for the <code>Mojo</code> inside the <code>Maven</code> system, and allows
42 * the <code>Mojo</code> to communicate errors.
43 *
44 * @throws MojoExecutionException if an unexpected problem occurs.
45 * Throwing this exception causes a "BUILD ERROR" message to be displayed.
46 * @throws MojoFailureException if an expected problem (such as a compilation failure) occurs.
47 * Throwing this exception causes a "BUILD FAILURE" message to be displayed.
48 */
49 void execute()
50 throws MojoExecutionException, MojoFailureException;
51
52 /**
53 * Inject a standard <code>Maven</code> logging mechanism to allow this <code>Mojo</code> to communicate events
54 * and feedback to the user.
55 *
56 * @param log a new logger
57 */
58 // TODO not sure about this here, and may want a getLog on here as well/instead
59 void setLog( Log log );
60
61 /**
62 * Furnish access to the standard Maven logging mechanism which is managed in this base class.
63 *
64 * @return a log4j-like logger object which allows plugins to create messages at levels of <code>"debug"</code>,
65 * <code>"info"</code>, <code>"warn"</code>, and <code>"error"</code>. This logger is the accepted means to display
66 * information to the user.
67 */
68 Log getLog();
69 }