001 /* 002 $Id: SyntaxException.java,v 1.12 2005/04/14 08:46:22 blackdrag Exp $ 003 004 Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved. 005 006 Redistribution and use of this software and associated documentation 007 ("Software"), with or without modification, are permitted provided 008 that the following conditions are met: 009 010 1. Redistributions of source code must retain copyright 011 statements and notices. Redistributions must also contain a 012 copy of this document. 013 014 2. Redistributions in binary form must reproduce the 015 above copyright notice, this list of conditions and the 016 following disclaimer in the documentation and/or other 017 materials provided with the distribution. 018 019 3. The name "groovy" must not be used to endorse or promote 020 products derived from this Software without prior written 021 permission of The Codehaus. For written permission, 022 please contact info@codehaus.org. 023 024 4. Products derived from this Software may not be called "groovy" 025 nor may "groovy" appear in their names without prior written 026 permission of The Codehaus. "groovy" is a registered 027 trademark of The Codehaus. 028 029 5. Due credit should be given to The Codehaus - 030 http://groovy.codehaus.org/ 031 032 THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS 033 ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT 034 NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 035 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 036 THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 037 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 038 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 039 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 040 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 041 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 042 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 043 OF THE POSSIBILITY OF SUCH DAMAGE. 044 045 */ 046 package org.codehaus.groovy.syntax; 047 048 import org.codehaus.groovy.GroovyException; 049 050 /** Base exception indicating a syntax error. 051 * 052 * @author <a href="bob@werken.com">bob mcwhirter</a> 053 * 054 * @version $Id: SyntaxException.java,v 1.12 2005/04/14 08:46:22 blackdrag Exp $ 055 */ 056 public class SyntaxException extends GroovyException { 057 058 /** Line upon which the error occurred. */ 059 private int line; 060 061 /** Column upon which the error occurred. */ 062 private int column; 063 064 private String sourceLocator; 065 066 public SyntaxException(String message, int line, int column) { 067 super(message, false); 068 this.line = line; 069 this.column = column; 070 } 071 072 public SyntaxException(String message, Throwable cause, int line, int column) { 073 super(message, cause); 074 this.line = line; 075 this.column = column; 076 } 077 078 // Properties 079 // ---------------------------------------------------------------------- 080 public void setSourceLocator(String sourceLocator) { 081 this.sourceLocator = sourceLocator; 082 } 083 084 public String getSourceLocator() { 085 return this.sourceLocator; 086 } 087 088 /** Retrieve the line upon which the error occurred. 089 * 090 * @return The line. 091 */ 092 public int getLine() { 093 return line; 094 } 095 096 /** Retrieve the column upon which the error occurred. 097 * 098 * @return The column. 099 */ 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 }