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  /**
23   * An exception occurring during the execution of a plugin.
24   * <br/>
25   * Throwing this exception causes a "BUILD ERROR" message to be displayed.
26   *
27   * @author Brett Porter
28   */
29  public class MojoExecutionException
30      extends AbstractMojoExecutionException
31  {
32      /**
33       * Construct a new <code>MojoExecutionException</code> exception providing the source and a short and long message:
34       * these messages are used to improve the message written at the end of Maven build.
35       *
36       * @param source
37       * @param shortMessage
38       * @param longMessage
39       */
40      public MojoExecutionException( Object source, String shortMessage, String longMessage )
41      {
42          super( shortMessage );
43          this.source = source;
44          this.longMessage = longMessage;
45      }
46  
47      /**
48       * Construct a new <code>MojoExecutionException</code> exception wrapping an underlying <code>Exception</code>
49       * and providing a <code>message</code>.
50       *
51       * @param message
52       * @param cause
53       */
54      public MojoExecutionException( String message, Exception cause )
55      {
56          super( message, cause );
57      }
58  
59      /**
60       * Construct a new <code>MojoExecutionException</code> exception wrapping an underlying <code>Throwable</code>
61       * and providing a <code>message</code>.
62       *
63       * @param message
64       * @param cause
65       */
66      public MojoExecutionException( String message, Throwable cause )
67      {
68          super( message, cause );
69      }
70  
71      /**
72       * Construct a new <code>MojoExecutionException</code> exception providing a <code>message</code>.
73       *
74       * @param message
75       */
76      public MojoExecutionException( String message )
77      {
78          super( message );
79      }
80  }