View Javadoc

1   package org.apache.maven.shared.scriptinterpreter;
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   * Signals a failure of a sub build run by the Invoker Plugin. This can be caused by an unsuccessful pre-/post-build
24   * script or a failure of the forked Maven build itself.
25   * 
26   * @author Benjamin Bentmann
27   * @version $Id: RunFailureException.java 1199475 2011-11-08 21:51:13Z olamy $
28   */
29  public class RunFailureException
30      extends Exception
31  {
32  
33      /**
34       * The serial version identifier for this class.
35       */
36      private static final long serialVersionUID = 236131530635863815L;
37  
38      /**
39       * The type of the build failure.
40       */
41      private final String type;
42  
43      /**
44       * Creates a new exception with the specified detail message.
45       *
46       * @param message The detail message, may be <code>null</code>.
47       * @param type The type of build failure, may not be <code>null</code>.
48       */
49      public RunFailureException( String message, String type )
50      {
51          super( message );
52          if ( type == null )
53          {
54              throw new IllegalArgumentException( "missing failure type" );
55          }
56          this.type = type;
57      }
58  
59      /**
60       * Returns the type of build failure.
61       * 
62       * @return The type of build failure, never <code>null</code>.
63       */
64      public String getType()
65      {
66          return type;
67      }
68  
69  }