View Javadoc

    1   /*
    2    $Id: SyntaxException.java 2129 2005-04-14 08:46:30Z blackdrag $
    3
    4    Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
    5
    6    Redistribution and use of this software and associated documentation
    7    ("Software"), with or without modification, are permitted provided
    8    that the following conditions are met:
    9
    10   1. Redistributions of source code must retain copyright
    11      statements and notices.  Redistributions must also contain a
    12      copy of this document.
    13
    14   2. Redistributions in binary form must reproduce the
    15      above copyright notice, this list of conditions and the
    16      following disclaimer in the documentation and/or other
    17      materials provided with the distribution.
    18
    19   3. The name "groovy" must not be used to endorse or promote
    20      products derived from this Software without prior written
    21      permission of The Codehaus.  For written permission,
    22      please contact info@codehaus.org.
    23
    24   4. Products derived from this Software may not be called "groovy"
    25      nor may "groovy" appear in their names without prior written
    26      permission of The Codehaus. "groovy" is a registered
    27      trademark of The Codehaus.
    28
    29   5. Due credit should be given to The Codehaus -
    30      http://groovy.codehaus.org/
    31
    32   THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
    33   ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
    34   NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
    35   FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
    36   THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
    37   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    38   (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
    39   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    40   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
    41   STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    42   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    43   OF THE POSSIBILITY OF SUCH DAMAGE.
    44
    45   */
    46  package org.codehaus.groovy.syntax;
    47
    48  import org.codehaus.groovy.GroovyException;
    49
    50  /*** Base exception indicating a syntax error.
    51   *
    52   *  @author <a href="bob@werken.com">bob mcwhirter</a>
    53   *
    54   *  @version $Id: SyntaxException.java 2129 2005-04-14 08:46:30Z blackdrag $
    55   */
    56  public class SyntaxException extends GroovyException {
    57
    58      /*** Line upon which the error occurred. */
    59      private int line;
    60
    61      /*** Column upon which the error occurred. */
    62      private int column;
    63
    64      private String sourceLocator;
    65
    66      public SyntaxException(String message, int line, int column) {
    67          super(message, false);
    68          this.line = line;
    69          this.column = column;
    70      }
    71
    72      public SyntaxException(String message, Throwable cause, int line, int column) {
    73          super(message, cause);
    74          this.line = line;
    75          this.column = column;
    76      }
    77
    78      // Properties
    79      // ----------------------------------------------------------------------
    80      public void setSourceLocator(String sourceLocator) {
    81          this.sourceLocator = sourceLocator;
    82      }
    83
    84      public String getSourceLocator() {
    85          return this.sourceLocator;
    86      }
    87
    88      /*** Retrieve the line upon which the error occurred.
    89       *
    90       *  @return The line.
    91       */
    92      public int getLine() {
    93          return line;
    94      }
    95
    96      /*** Retrieve the column upon which the error occurred.
    97       *
    98       *  @return The column.
    99       */
    100     public int getStartColumn() {
    101         return column;
    102     }
    103
    104     /***
    105      * @return the end of the line on which the error occurs
    106      */
    107     public int getStartLine() {
    108         return getLine();
    109     }
    110
    111     /***
    112      * @return the end column on which the error occurs
    113      */
    114     public int getEndColumn() {
    115         return getStartColumn() + 1;
    116     }
    117
    118     public String getMessage() {
    119         String msg = super.getMessage() + " @ line " + line + ", column " + column + ".";
    120         return msg;
    121     }
    122 }