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 */
26 public class MojoFailureException extends AbstractMojoExecutionException {
27 /**
28 * Construct a new <code>MojoFailureException</code> exception providing the source and a short and long message:
29 * these messages are used to improve the message written at the end of Maven build.
30 *
31 * @param source
32 * @param shortMessage
33 * @param longMessage
34 */
35 public MojoFailureException(Object source, String shortMessage, String longMessage) {
36 super(shortMessage);
37 this.source = source;
38 this.longMessage = longMessage;
39 }
40
41 /**
42 * Construct a new <code>MojoFailureException</code> exception providing a message.
43 *
44 * @param message
45 */
46 public MojoFailureException(String message) {
47 super(message);
48 }
49
50 /**
51 * Construct a new <code>MojoFailureException</code> exception wrapping an underlying <code>Throwable</code>
52 * and providing a <code>message</code>.
53 *
54 * @param message
55 * @param cause
56 * @since 2.0.9
57 */
58 public MojoFailureException(String message, Throwable cause) {
59 super(message, cause);
60 }
61
62 /**
63 * Constructs a new {@code MojoFailureException} exception wrapping an underlying {@code Throwable}.
64 *
65 * @param cause the cause which is saved for later retrieval by the {@link #getCause()} method.
66 * A {@code null} value is permitted, and indicates that the cause is nonexistent or unknown.
67 * @since 3.8.3
68 */
69 public MojoFailureException(Throwable cause) {
70 super(cause);
71 }
72 }