1 package org.apache.maven.api.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 import org.apache.maven.api.annotations.Experimental;
23 import org.apache.maven.api.services.MavenException;
24
25 /**
26 * An exception occurring during the execution of a plugin.
27 *
28 * @since 4.0
29 */
30 @Experimental
31 public class MojoException
32 extends MavenException
33 {
34
35 protected Object source;
36
37 protected String longMessage;
38
39 /**
40 * Construct a new <code>MojoExecutionException</code> exception providing the source and a short and long message:
41 * these messages are used to improve the message written at the end of Maven build.
42 */
43 public MojoException( Object source, String shortMessage, String longMessage )
44 {
45 super( shortMessage );
46 this.source = source;
47 this.longMessage = longMessage;
48 }
49
50 /**
51 * Construct a new <code>MojoExecutionException</code> exception wrapping an underlying <code>Exception</code>
52 * and providing a <code>message</code>.
53 */
54 public MojoException( 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 public MojoException( String message, Throwable cause )
64 {
65 super( message, cause );
66 }
67
68 /**
69 * Construct a new <code>MojoExecutionException</code> exception providing a <code>message</code>.
70 */
71 public MojoException( String message )
72 {
73 super( message );
74 }
75
76 /**
77 * Constructs a new {@code MojoExecutionException} exception wrapping an underlying {@code Throwable}.
78 *
79 * @param cause the cause which is saved for later retrieval by the {@link #getCause()} method.
80 * A {@code null} value is permitted, and indicates that the cause is nonexistent or unknown.
81 * @since 3.8.3
82 */
83 public MojoException( Throwable cause )
84 {
85 super( cause );
86 }
87
88 public String getLongMessage()
89 {
90 return longMessage;
91 }
92
93 public Object getSource()
94 {
95 return source;
96 }
97
98 }