1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.plugin;
20
21 /**
22 * An exception occurring during the execution of a plugin (such as a compilation failure).<br>
23 * Throwing this exception causes a "BUILD FAILURE" message to be displayed.
24 *
25 * @author Brett Porter
26 */
27 public class MojoFailureException extends AbstractMojoExecutionException {
28 /**
29 * Construct a new <code>MojoFailureException</code> exception providing the source and a short and long message:
30 * these messages are used to improve the message written at the end of Maven build.
31 *
32 * @param source
33 * @param shortMessage
34 * @param longMessage
35 */
36 public MojoFailureException(Object source, String shortMessage, String longMessage) {
37 super(shortMessage);
38 this.source = source;
39 this.longMessage = longMessage;
40 }
41
42 /**
43 * Construct a new <code>MojoFailureException</code> exception providing a message.
44 *
45 * @param message
46 */
47 public MojoFailureException(String message) {
48 super(message);
49 }
50
51 /**
52 * Construct a new <code>MojoFailureException</code> exception wrapping an underlying <code>Throwable</code>
53 * and providing a <code>message</code>.
54 *
55 * @param message
56 * @param cause
57 * @since 2.0.9
58 */
59 public MojoFailureException(String message, Throwable cause) {
60 super(message, cause);
61 }
62
63 /**
64 * Constructs a new {@code MojoFailureException} exception wrapping an underlying {@code Throwable}.
65 *
66 * @param cause the cause which is saved for later retrieval by the {@link #getCause()} method.
67 * A {@code null} value is permitted, and indicates that the cause is nonexistent or unknown.
68 * @since 3.8.3
69 */
70 public MojoFailureException(Throwable cause) {
71 super(cause);
72 }
73 }