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