1 package org.apache.maven.doxia.module.apt;
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.doxia.parser.ParseException;
23
24 /**
25 * Wraps an exception when parsing apt source documents.
26 *
27 * @since 1.0
28 */
29 public class AptParseException
30 extends ParseException
31 {
32 /** serialVersionUID */
33 static final long serialVersionUID = 1694654412921168623L;
34
35 /**
36 * Construct a new AptParseException 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 AptParseException( String message )
42 {
43 super( message );
44 }
45
46 /**
47 * Construct a new AptParseException with the specified detail message and cause.
48 *
49 * @param message The detailed message.
50 * This can later be retrieved by the <code>Throwable.getMessage()</code> method.
51 * @param e the cause. This can be retrieved later by the <code>Throwable.getCause()</code> method.
52 * (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
53 */
54 public AptParseException( String message, Exception e )
55 {
56 super( message, e );
57 }
58
59 /**
60 * Construct a new AptParseException with the specified cause, detail message,
61 * filename, line number and column number.
62 *
63 * @param message The detailed message.
64 * This can later be retrieved by the <code>Throwable.getMessage()</code> method.
65 * @param e the cause. This can be retrieved later by the <code>Throwable.getCause()</code> method.
66 * (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
67 * @param name Name of a file that couldn't be parsed.
68 * This can later be retrieved by the getFileName() method.
69 * @param line The line number where the parsing failed.
70 * This can later be retrieved by the getLineNumber() method.
71 * @param column The column number where the parsing failed.
72 * This can later be retrieved by the getColumnNumber() method.
73 */
74 public AptParseException( String message, Exception e, String name, int line, int column )
75 {
76 super( e, message, name, line, column );
77 }
78
79 /**
80 * Construct a new AptParseException with the specified detail message and cause.
81 *
82 * @param message The detailed message.
83 * This can later be retrieved by the <code>Throwable.getMessage()</code> method.
84 * @param e the cause. This can be retrieved later by the <code>Throwable.getCause()</code> method.
85 * (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
86 * @param line The line number where the parsing failed.
87 * This can later be retrieved by the getLineNumber() method.
88 * @param column The column number where the parsing failed.
89 * This can later be retrieved by the getColumnNumber() method.
90 */
91 public AptParseException( String message, Exception e, int line, int column )
92 {
93 super( message, e, line, column );
94 }
95 }