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 * @version $Id: AptParseException.java 638290 2008-03-18 09:45:22Z bentmann $ 28 * @since 1.0 29 */ 30 public class AptParseException 31 extends ParseException 32 { 33 /** serialVersionUID */ 34 static final long serialVersionUID = 1694654412921168623L; 35 36 /** 37 * Construct a new AptParseException with the specified detail message. 38 * 39 * @param message The detailed message. 40 * This can later be retrieved by the <code>Throwable.getMessage()</code> method. 41 */ 42 public AptParseException( String message ) 43 { 44 super( message ); 45 } 46 47 /** 48 * Construct a new AptParseException with the specified 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 e the cause. This can be retrieved later by the <code>Throwable.getCause()</code> method. 53 * (A null value is permitted, and indicates that the cause is nonexistent or unknown.) 54 */ 55 public AptParseException( String message, Exception e ) 56 { 57 super( message, e ); 58 } 59 60 /** 61 * Construct a new AptParseException with the specified cause, detail message, 62 * filename, line number and column number. 63 * 64 * @param message The detailed message. 65 * This can later be retrieved by the <code>Throwable.getMessage()</code> method. 66 * @param e the cause. This can be retrieved later by the <code>Throwable.getCause()</code> method. 67 * (A null value is permitted, and indicates that the cause is nonexistent or unknown.) 68 * @param name Name of a file that couldn't be parsed. 69 * This can later be retrieved by the getFileName() method. 70 * @param line The line number where the parsing failed. 71 * This can later be retrieved by the getLineNumber() method. 72 * @param column The column number where the parsing failed. 73 * This can later be retrieved by the getColumnNumber() method. 74 */ 75 public AptParseException( String message, Exception e, String name, int line, int column ) 76 { 77 super( e, message, name, line, column ); 78 } 79 80 /** 81 * Construct a new AptParseException with the specified detail message and cause. 82 * 83 * @param message The detailed message. 84 * This can later be retrieved by the <code>Throwable.getMessage()</code> method. 85 * @param e the cause. This can be retrieved later by the <code>Throwable.getCause()</code> method. 86 * (A null value is permitted, and indicates that the cause is nonexistent or unknown.) 87 * @param line The line number where the parsing failed. 88 * This can later be retrieved by the getLineNumber() method. 89 * @param column The column number where the parsing failed. 90 * This can later be retrieved by the getColumnNumber() method. 91 */ 92 public AptParseException( String message, Exception e, int line, int column ) 93 { 94 super( message, e, line, column ); 95 } 96 }