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 (such as a compilation failure).
24 * <br/>
25 * Throwing this exception causes a "BUILD FAILURE" message to be displayed.
26 *
27 * @author Brett Porter
28 */
29 public class MojoFailureException
30 extends AbstractMojoExecutionException
31 {
32 /**
33 * Construct a new <code>MojoFailureException</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 MojoFailureException( 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>MojoFailureException</code> exception providing a message.
49 *
50 * @param message
51 */
52 public MojoFailureException( String message )
53 {
54 super( message );
55 }
56
57 /**
58 * Construct a new <code>MojoFailureException</code> exception wrapping an underlying <code>Throwable</code>
59 * and providing a <code>message</code>.
60 *
61 * @param message
62 * @param cause
63 * @since 2.0.9
64 */
65 public MojoFailureException( String message, Throwable cause )
66 {
67 super( message, cause );
68 }
69 }