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