001: /* ====================================================================
002: * Tea - Copyright (c) 1997-2000 Walt Disney Internet Group
003: * ====================================================================
004: * The Tea Software License, Version 1.1
005: *
006: * Copyright (c) 2000 Walt Disney Internet Group. All rights reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * 1. Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * 2. Redistributions in binary form must reproduce the above copyright
016: * notice, this list of conditions and the following disclaimer in
017: * the documentation and/or other materials provided with the
018: * distribution.
019: *
020: * 3. The end-user documentation included with the redistribution,
021: * if any, must include the following acknowledgment:
022: * "This product includes software developed by the
023: * Walt Disney Internet Group (http://opensource.go.com/)."
024: * Alternately, this acknowledgment may appear in the software itself,
025: * if and wherever such third-party acknowledgments normally appear.
026: *
027: * 4. The names "Tea", "TeaServlet", "Kettle", "Trove" and "BeanDoc" must
028: * not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact opensource@dig.com.
031: *
032: * 5. Products derived from this software may not be called "Tea",
033: * "TeaServlet", "Kettle" or "Trove", nor may "Tea", "TeaServlet",
034: * "Kettle", "Trove" or "BeanDoc" appear in their name, without prior
035: * written permission of the Walt Disney Internet Group.
036: *
037: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
038: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
039: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
040: * DISCLAIMED. IN NO EVENT SHALL THE WALT DISNEY INTERNET GROUP OR ITS
041: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
042: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
043: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
044: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
045: * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
046: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
047: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
048: * ====================================================================
049: *
050: * For more information about Tea, please see http://opensource.go.com/.
051: */
052:
053: package com.go.tea.compiler;
054:
055: /******************************************************************************
056: *
057: * @author Brian S O'Neill
058: * @version
059: * <!--$$Revision:--> 14 <!-- $-->, <!--$$JustDate:--> 9/07/00 <!-- $-->
060: */
061: public class ErrorEvent extends java.util.EventObject {
062:
063: private String mErrorMsg;
064: private Token mCulprit;
065: private SourceInfo mInfo;
066: private CompilationUnit mUnit;
067:
068: ErrorEvent(Object source, String errorMsg, Token culprit) {
069: this (source, errorMsg, culprit, null);
070: }
071:
072: ErrorEvent(Object source, String errorMsg, SourceInfo info) {
073: this (source, errorMsg, info, null);
074: }
075:
076: ErrorEvent(Object source, String errorMsg, Token culprit,
077: CompilationUnit unit) {
078: super (source);
079: mErrorMsg = errorMsg;
080: mCulprit = culprit;
081: if (culprit != null) {
082: mInfo = culprit.getSourceInfo();
083: }
084: mUnit = unit;
085: }
086:
087: ErrorEvent(Object source, String errorMsg, SourceInfo info,
088: CompilationUnit unit) {
089: super (source);
090: mErrorMsg = errorMsg;
091: mInfo = info;
092: mUnit = unit;
093: }
094:
095: public String getErrorMessage() {
096: return mErrorMsg;
097: }
098:
099: /**
100: * Returns the error message prepended with source file information.
101: */
102: public String getDetailedErrorMessage() {
103: String prepend = getSourceInfoMessage();
104: if (prepend == null || prepend.length() == 0) {
105: return mErrorMsg;
106: } else {
107: return prepend + ": " + mErrorMsg;
108: }
109: }
110:
111: public String getSourceInfoMessage() {
112: String msg;
113: if (mUnit == null) {
114: if (mInfo == null) {
115: msg = "";
116: } else {
117: msg = String.valueOf(mInfo.getLine());
118: }
119: } else {
120: if (mInfo == null) {
121: msg = mUnit.getSourceFileName();
122: } else {
123: msg = mUnit.getSourceFileName() + ':' + mInfo.getLine();
124: }
125: }
126:
127: return msg;
128: }
129:
130: /**
131: * This method reports on where in the source code an error was found.
132: *
133: * @return Source information on this error or null if not known.
134: */
135: public SourceInfo getSourceInfo() {
136: return mInfo;
137: }
138:
139: /**
140: * @return Null if there was no offending token
141: */
142: public Token getCulpritToken() {
143: return mCulprit;
144: }
145:
146: /**
147: * @return Null if there was no CompilationUnit
148: */
149: public CompilationUnit getCompilationUnit() {
150: return mUnit;
151: }
152: }
|