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.<br>
23 * Throwing this exception causes a "BUILD ERROR" message to be displayed.
24 *
25 * @author Brett Porter
26 */
27 public class MojoExecutionException extends AbstractMojoExecutionException {
28 /**
29 * Construct a new <code>MojoExecutionException</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 MojoExecutionException(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>MojoExecutionException</code> exception wrapping an underlying <code>Exception</code>
44 * and providing a <code>message</code>.
45 *
46 * @param message
47 * @param cause
48 */
49 public MojoExecutionException(String message, Exception cause) {
50 super(message, cause);
51 }
52
53 /**
54 * Construct a new <code>MojoExecutionException</code> exception wrapping an underlying <code>Throwable</code>
55 * and providing a <code>message</code>.
56 *
57 * @param message
58 * @param cause
59 */
60 public MojoExecutionException(String message, Throwable cause) {
61 super(message, cause);
62 }
63
64 /**
65 * Construct a new <code>MojoExecutionException</code> exception providing a <code>message</code>.
66 *
67 * @param message
68 */
69 public MojoExecutionException(String message) {
70 super(message);
71 }
72
73 /**
74 * Constructs a new {@code MojoExecutionException} exception wrapping an underlying {@code Throwable}.
75 *
76 * @param cause the cause which is saved for later retrieval by the {@link #getCause()} method.
77 * A {@code null} value is permitted, and indicates that the cause is nonexistent or unknown.
78 * @since 3.8.3
79 */
80 public MojoExecutionException(Throwable cause) {
81 super(cause);
82 }
83 }