View Javadoc

1   package org.apache.maven.doxia.macro;
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   * Wrap an exception that occurs during the execution of a Doxia macro.
24   *
25   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
26   * @version $Id: MacroExecutionException.java 636300 2008-03-12 12:46:19Z vsiveton $
27   * @since 1.0
28   */
29  public class MacroExecutionException
30      extends Exception
31  {
32      /** serialVersionUID */
33      static final long serialVersionUID = -6314856898570018814L;
34  
35      /**
36       * Construct a new <code>MacroExecutionException</code> with the specified detail message.
37       *
38       * @param message The detailed message.
39       * This can later be retrieved by the <code>Throwable.getMessage()</code> method.
40       */
41      public MacroExecutionException( String message )
42      {
43          super( message );
44      }
45  
46      /**
47       * Construct a new <code>MacroExecutionException</code> with the specified
48       * detail message and cause.
49       *
50       * @param message The detailed message.
51       * This can later be retrieved by the <code>Throwable.getMessage()</code> method.
52       * @param cause the cause. This can be retrieved later by the
53       * <code>Throwable.getCause()</code> method. (A null value is permitted, and indicates
54       * that the cause is nonexistent or unknown.)
55       */
56      public MacroExecutionException( String message, Throwable cause )
57      {
58          super( message, cause );
59      }
60  }