View Javadoc

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