View Javadoc

1   package org.apache.velocity.exception;
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   * All Exceptions that can provide additional information about the place
24   * where the error happened (template name, column and line number) can
25   * implement this interface and the ParseErrorException will then be able
26   * to deal with this information.
27   *
28   * @author <a href="hps@intermeta.de">Henning P. Schmiedehausen</a>
29   * @version $Id: ExtendedParseException.java 685685 2008-08-13 21:43:27Z nbubna $
30   * @since 1.5
31   */
32  public interface ExtendedParseException
33  {
34      /**
35       * returns the Template name where this exception occured.
36       * @return The Template name where this exception occured.
37       */
38      String getTemplateName();
39  
40      /**
41       * returns the line number where this exception occured.
42       * @return The line number where this exception occured.
43       */
44      int getLineNumber();
45  
46      /**
47       * returns the column number where this exception occured.
48       * @return The column number where this exception occured.
49       */
50      int getColumnNumber();
51  }
52