001: /*--
002:
003: $Id: JDOMParseException.java,v 1.7 2004/02/17 02:29:24 jhunter Exp $
004:
005: Copyright (C) 2000-2004 Jason Hunter & Brett McLaughlin.
006: 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 disclaimer that follows
017: these conditions in the documentation and/or other materials
018: provided with the distribution.
019:
020: 3. The name "JDOM" must not be used to endorse or promote products
021: derived from this software without prior written permission. For
022: written permission, please contact <request_AT_jdom_DOT_org>.
023:
024: 4. Products derived from this software may not be called "JDOM", nor
025: may "JDOM" appear in their name, without prior written permission
026: from the JDOM Project Management <request_AT_jdom_DOT_org>.
027:
028: In addition, we request (but do not require) that you include in the
029: end-user documentation provided with the redistribution and/or in the
030: software itself an acknowledgement equivalent to the following:
031: "This product includes software developed by the
032: JDOM Project (http://www.jdom.org/)."
033: Alternatively, the acknowledgment may be graphical using the logos
034: available at http://www.jdom.org/images/logos.
035:
036: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT
040: CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: SUCH DAMAGE.
048:
049: This software consists of voluntary contributions made by many
050: individuals on behalf of the JDOM Project and was originally
051: created by Jason Hunter <jhunter_AT_jdom_DOT_org> and
052: Brett McLaughlin <brett_AT_jdom_DOT_org>. For more information
053: on the JDOM Project, please see <http://www.jdom.org/>.
054:
055: */
056:
057: package org.jdom.input;
058:
059: import org.jdom.*;
060: import org.xml.sax.*;
061:
062: /**
063: * Thrown during parse errors, with information about where the parse error
064: * occurred as well as access to the partially built document.
065: *
066: * @version $Revision: 1.7 $, $Date: 2004/02/17 02:29:24 $
067: * @author Laurent Bihanic
068: */
069: public class JDOMParseException extends JDOMException {
070:
071: private static final String CVS_ID = "@(#) $RCSfile: JDOMParseException.java,v $ $Revision: 1.7 $ $Date: 2004/02/17 02:29:24 $ $Name: jdom_1_0 $";
072:
073: /**
074: * The portion of the document that was successfully built before
075: * the parse error occurred.
076: */
077: private final Document partialDocument;
078:
079: /**
080: * This will create a parse <code>Exception</code> with the given
081: * message and wrap the <code>Exception</code> that cause a document
082: * parse to fail.
083: *
084: * @param message <code>String</code> message indicating
085: * the problem that occurred.
086: * @param cause <code>Throwable</code> that caused this
087: * to be thrown.
088: */
089: public JDOMParseException(String message, Throwable cause) {
090: this (message, cause, null);
091: }
092:
093: /**
094: * This will create a parse <code>Exception</code> with the given
095: * message and the partial document and wrap the
096: * <code>Exception</code> that cause a document parse to fail.
097: *
098: * @param message <code>String</code> message indicating
099: * the problem that occurred.
100: * @param cause <code>Throwable</code> that caused this
101: * to be thrown.
102: * @param partialDocument <code>Document</code> the portion of
103: * the input XML document that was
104: * successfully built.
105: */
106: public JDOMParseException(String message, Throwable cause,
107: Document partialDocument) {
108: super (message, cause);
109: this .partialDocument = partialDocument;
110: }
111:
112: /**
113: * Returns the partial document that was successfully built before
114: * the error occurred.
115: *
116: * @return the partial document or null if none.
117: */
118: public Document getPartialDocument() {
119: return partialDocument;
120: }
121:
122: /**
123: * Returns the public identifier of the entity where the
124: * parse error occurred.
125: *
126: * @return a string containing the public identifier, or
127: * <code>null</code> if the information is not available.
128: */
129: public String getPublicId() {
130: return (getCause() instanceof SAXParseException) ? ((SAXParseException) getCause())
131: .getPublicId()
132: : null;
133: }
134:
135: /**
136: * Returns the system identifier of the entity where the
137: * parse error occurred.
138: *
139: * @return a string containing the system identifier, or
140: * <code>null</code> if the information is not available.
141: */
142: public String getSystemId() {
143: return (getCause() instanceof SAXParseException) ? ((SAXParseException) getCause())
144: .getSystemId()
145: : null;
146: }
147:
148: /**
149: * Returns the line number of the end of the text where the
150: * parse error occurred.
151: * <p>
152: * The first line in the document is line 1.</p>
153: *
154: * @return an integer representing the line number, or -1
155: * if the information is not available.
156: */
157: public int getLineNumber() {
158: return (getCause() instanceof SAXParseException) ? ((SAXParseException) getCause())
159: .getLineNumber()
160: : -1;
161: }
162:
163: /**
164: * Returns the column number of the end of the text where the
165: * parse error occurred.
166: * <p>
167: * The first column in a line is position 1.</p>
168: *
169: * @return an integer representing the column number, or -1
170: * if the information is not available.
171: */
172: public int getColumnNumber() {
173: return (getCause() instanceof SAXParseException) ? ((SAXParseException) getCause())
174: .getColumnNumber()
175: : -1;
176: }
177: }
|