001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: /*
038: * Use is subject to the license terms.
039: */
040: package com.sun.tools.xjc;
041:
042: import com.sun.istack.SAXParseException2;
043: import com.sun.tools.xjc.api.ErrorListener;
044:
045: import org.xml.sax.ErrorHandler;
046: import org.xml.sax.Locator;
047: import org.xml.sax.SAXParseException;
048:
049: /**
050: * Implemented by the driver of the compiler engine to handle
051: * errors found during the compiliation.
052: *
053: * <p>
054: * This class implements {@link ErrorHandler} so it can be
055: * passed to anywhere where {@link ErrorHandler} is expected.
056: *
057: * <p>
058: * However, to make the error handling easy (and make it work
059: * with visitor patterns nicely),
060: * none of the methods on thi class throws {@link org.xml.sax.SAXException}.
061: * Instead, when the compilation needs to be aborted,
062: * it throws {@link AbortException}, which is unchecked.
063: *
064: * <p>
065: * This also implements the externally visible {@link ErrorListener}
066: * so that we can reuse our internal implementation for testing and such.
067: *
068: * @author Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
069: */
070: public abstract class ErrorReceiver implements ErrorHandler,
071: ErrorListener {
072:
073: //
074: //
075: // convenience methods for callers
076: //
077: //
078: /**
079: * @param loc
080: * can be null if the location is unknown
081: */
082: public final void error(Locator loc, String msg) {
083: error(new SAXParseException2(msg, loc));
084: }
085:
086: public final void error(Locator loc, String msg, Exception e) {
087: error(new SAXParseException2(msg, loc, e));
088: }
089:
090: public final void error(String msg, Exception e) {
091: error(new SAXParseException2(msg, null, e));
092: }
093:
094: public void error(Exception e) {
095: error(e.getMessage(), e);
096: }
097:
098: /**
099: * @param loc
100: * can be null if the location is unknown
101: */
102: public final void warning(Locator loc, String msg) {
103: warning(new SAXParseException(msg, loc));
104: }
105:
106: //
107: //
108: // ErrorHandler implementation, but can't throw SAXException
109: //
110: //
111: public abstract void error(SAXParseException exception)
112: throws AbortException;
113:
114: public abstract void fatalError(SAXParseException exception)
115: throws AbortException;
116:
117: public abstract void warning(SAXParseException exception)
118: throws AbortException;
119:
120: /**
121: * This method will be invoked periodically to allow {@link AbortException}
122: * to be thrown, especially when this is driven by some kind of GUI.
123: */
124: public void pollAbort() throws AbortException {
125: }
126:
127: /**
128: * Reports verbose messages to users.
129: *
130: * This method can be used to report additional non-essential
131: * messages. The implementation usually discards them
132: * unless some specific debug option is turned on.
133: */
134: public abstract void info(SAXParseException exception) /*REVISIT:throws AbortException*/;
135:
136: /**
137: * Reports a debug message to users.
138: *
139: * @see #info(SAXParseException)
140: */
141: public final void debug(String msg) {
142: info(new SAXParseException(msg, null));
143: }
144:
145: //
146: //
147: // convenience methods for derived classes
148: //
149: //
150:
151: /**
152: * Returns the human readable string representation of the
153: * {@link org.xml.sax.Locator} part of the specified
154: * {@link SAXParseException}.
155: *
156: * @return non-null valid object.
157: */
158: protected final String getLocationString(SAXParseException e) {
159: if (e.getLineNumber() != -1 || e.getSystemId() != null) {
160: int line = e.getLineNumber();
161: return Messages.format(Messages.LINE_X_OF_Y,
162: line == -1 ? "?" : Integer.toString(line),
163: getShortName(e.getSystemId()));
164: } else {
165: return Messages.format(Messages.UNKNOWN_LOCATION);
166: }
167: }
168:
169: /** Computes a short name of a given URL for display. */
170: private String getShortName(String url) {
171: if (url == null)
172: return Messages.format(Messages.UNKNOWN_FILE);
173:
174: // sometimes the user deals with a set of schems that reference each other
175: // in a complicated way, and end up importing two versions of the same schema.
176: // just printing the file name makes it very difficult to recognize of this problem.
177: // so I decided to change it back to print the full URL.
178:
179: // int idx;
180: //
181: // // system Id can be URL, so we can't use File.separator
182: // idx = url.lastIndexOf('/');
183: // if(idx!=-1) return url.substring(idx+1);
184: // idx = url.lastIndexOf('\\');
185: // if(idx!=-1) return url.substring(idx+1);
186:
187: return url;
188: }
189: }
|