Source code: org/jdom/input/JDOMParseException.java
1 /*--
2
3 $Id: JDOMParseException.java,v 1.7 2004/02/17 02:29:24 jhunter Exp $
4
5 Copyright (C) 2000-2004 Jason Hunter & Brett McLaughlin.
6 All rights reserved.
7
8 Redistribution and use in source and binary forms, with or without
9 modification, are permitted provided that the following conditions
10 are met:
11
12 1. Redistributions of source code must retain the above copyright
13 notice, this list of conditions, and the following disclaimer.
14
15 2. Redistributions in binary form must reproduce the above copyright
16 notice, this list of conditions, and the disclaimer that follows
17 these conditions in the documentation and/or other materials
18 provided with the distribution.
19
20 3. The name "JDOM" must not be used to endorse or promote products
21 derived from this software without prior written permission. For
22 written permission, please contact <request_AT_jdom_DOT_org>.
23
24 4. Products derived from this software may not be called "JDOM", nor
25 may "JDOM" appear in their name, without prior written permission
26 from the JDOM Project Management <request_AT_jdom_DOT_org>.
27
28 In addition, we request (but do not require) that you include in the
29 end-user documentation provided with the redistribution and/or in the
30 software itself an acknowledgement equivalent to the following:
31 "This product includes software developed by the
32 JDOM Project (http://www.jdom.org/)."
33 Alternatively, the acknowledgment may be graphical using the logos
34 available at http://www.jdom.org/images/logos.
35
36 THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39 DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT
40 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47 SUCH DAMAGE.
48
49 This software consists of voluntary contributions made by many
50 individuals on behalf of the JDOM Project and was originally
51 created by Jason Hunter <jhunter_AT_jdom_DOT_org> and
52 Brett McLaughlin <brett_AT_jdom_DOT_org>. For more information
53 on the JDOM Project, please see <http://www.jdom.org/>.
54
55 */
56
57 package org.jdom.input;
58
59 import org.jdom.*;
60 import org.xml.sax.*;
61
62 /**
63 * Thrown during parse errors, with information about where the parse error
64 * occurred as well as access to the partially built document.
65 *
66 * @version $Revision: 1.7 $, $Date: 2004/02/17 02:29:24 $
67 * @author Laurent Bihanic
68 */
69 public class JDOMParseException extends JDOMException {
70
71 private static final String CVS_ID =
72 "@(#) $RCSfile: JDOMParseException.java,v $ $Revision: 1.7 $ $Date: 2004/02/17 02:29:24 $ $Name: jdom_1_0 $";
73
74 /**
75 * The portion of the document that was successfully built before
76 * the parse error occurred.
77 */
78 private final Document partialDocument;
79
80 /**
81 * This will create a parse <code>Exception</code> with the given
82 * message and wrap the <code>Exception</code> that cause a document
83 * parse to fail.
84 *
85 * @param message <code>String</code> message indicating
86 * the problem that occurred.
87 * @param cause <code>Throwable</code> that caused this
88 * to be thrown.
89 */
90 public JDOMParseException(String message, Throwable cause) {
91 this(message, cause, null);
92 }
93
94 /**
95 * This will create a parse <code>Exception</code> with the given
96 * message and the partial document and wrap the
97 * <code>Exception</code> that cause a document parse to fail.
98 *
99 * @param message <code>String</code> message indicating
100 * the problem that occurred.
101 * @param cause <code>Throwable</code> that caused this
102 * to be thrown.
103 * @param partialDocument <code>Document</code> the portion of
104 * the input XML document that was
105 * successfully built.
106 */
107 public JDOMParseException(String message, Throwable cause,
108 Document partialDocument) {
109 super(message, cause);
110 this.partialDocument = partialDocument;
111 }
112
113 /**
114 * Returns the partial document that was successfully built before
115 * the error occurred.
116 *
117 * @return the partial document or null if none.
118 */
119 public Document getPartialDocument() {
120 return partialDocument;
121 }
122
123 /**
124 * Returns the public identifier of the entity where the
125 * parse error occurred.
126 *
127 * @return a string containing the public identifier, or
128 * <code>null</code> if the information is not available.
129 */
130 public String getPublicId() {
131 return (getCause() instanceof SAXParseException)?
132 ((SAXParseException)getCause()).getPublicId(): 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)?
144 ((SAXParseException)getCause()).getSystemId(): null;
145 }
146
147 /**
148 * Returns the line number of the end of the text where the
149 * parse error occurred.
150 * <p>
151 * The first line in the document is line 1.</p>
152 *
153 * @return an integer representing the line number, or -1
154 * if the information is not available.
155 */
156 public int getLineNumber() {
157 return (getCause() instanceof SAXParseException)?
158 ((SAXParseException)getCause()).getLineNumber(): -1;
159 }
160
161 /**
162 * Returns the column number of the end of the text where the
163 * parse error occurred.
164 * <p>
165 * The first column in a line is position 1.</p>
166 *
167 * @return an integer representing the column number, or -1
168 * if the information is not available.
169 */
170 public int getColumnNumber() {
171 return (getCause() instanceof SAXParseException)?
172 ((SAXParseException)getCause()).getColumnNumber(): -1;
173 }
174 }
175