KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > DocumentException


1 /*
2  * $Id: DocumentException.java 2748 2007-05-12 15:11:48Z blowagie $
3  * $Name$
4  *
5  * Copyright 1999, 2000, 2001, 2002 by Bruno Lowagie.
6  *
7  * The contents of this file are subject to the Mozilla Public License Version 1.1
8  * (the "License"); you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
10  *
11  * Software distributed under the License is distributed on an "AS IS" basis,
12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13  * for the specific language governing rights and limitations under the License.
14  *
15  * The Original Code is 'iText, a free JAVA-PDF library'.
16  *
17  * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
18  * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
19  * All Rights Reserved.
20  * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
21  * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
22  *
23  * Contributor(s): all the names of the contributors are added in the source code
24  * where applicable.
25  *
26  * Alternatively, the contents of this file may be used under the terms of the
27  * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
28  * provisions of LGPL are applicable instead of those above. If you wish to
29  * allow use of your version of this file only under the terms of the LGPL
30  * License and not to allow others to use your version of this file under
31  * the MPL, indicate your decision by deleting the provisions above and
32  * replace them with the notice and other provisions required by the LGPL.
33  * If you do not delete the provisions above, a recipient may use your version
34  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
35  *
36  * This library is free software; you can redistribute it and/or modify it
37  * under the terms of the MPL as stated above or under the terms of the GNU
38  * Library General Public License as published by the Free Software Foundation;
39  * either version 2 of the License, or any later version.
40  *
41  * This library is distributed in the hope that it will be useful, but WITHOUT
42  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
43  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
44  * details.
45  *
46  * If you didn't download this code from the following link, you should check if
47  * you aren't using an obsolete version:
48  * http://www.lowagie.com/iText/
49  *
50  */
51
52 package com.lowagie.text;
53
54 /**
55  * Signals that an error has occurred in a <CODE>Document</CODE>.
56  *
57  * @see BadElementException
58  * @see Document
59  * @see DocWriter
60  * @see DocListener
61  */
62
63 public class DocumentException extends Exception JavaDoc {
64     private static final long serialVersionUID = -2191131489390840739L;
65     private Exception JavaDoc ex;
66
67     /**
68      * Creates a Document exception.
69      * @param ex an exception that has to be turned into a DocumentException
70      */
71     public DocumentException(Exception JavaDoc ex) {
72         this.ex = ex;
73     }
74     
75     // constructors
76
77     /**
78      * Constructs a <CODE>DocumentException</CODE> whithout a message.
79      */
80     public DocumentException() {
81         super();
82     }
83     
84     /**
85      * Constructs a <code>DocumentException</code> with a message.
86      *
87      * @param message a message describing the exception
88      */
89     public DocumentException(String JavaDoc message) {
90         super(message);
91     }
92
93     /**
94      * We print the message of the checked exception
95      * @return the error message
96      */
97     public String JavaDoc getMessage() {
98         if (ex == null)
99             return super.getMessage();
100         else
101             return ex.getMessage();
102     }
103
104     /**
105      * and make sure we also produce a localized version
106      * @return a localized message
107      */
108     public String JavaDoc getLocalizedMessage() {
109         if (ex == null)
110             return super.getLocalizedMessage();
111         else
112             return ex.getLocalizedMessage();
113     }
114
115     /**
116      * The toString() is changed to be prefixed with ExceptionConverter
117      * @return the String version of the exception
118      */
119     public String JavaDoc toString() {
120         if (ex == null)
121             return super.toString();
122         else
123             return split(getClass().getName()) + ": " + ex;
124     }
125
126     /** we have to override this as well */
127     public void printStackTrace() {
128         printStackTrace(System.err);
129     }
130
131     /**
132      * here we prefix, with s.print(), not s.println(), the stack
133      * trace with "ExceptionConverter:"
134      * @param s a printstream object
135      */
136     public void printStackTrace(java.io.PrintStream JavaDoc s) {
137         if (ex == null)
138             super.printStackTrace(s);
139         else {
140             synchronized (s) {
141                 s.print(split(getClass().getName()) + ": ");
142                 ex.printStackTrace(s);
143             }
144         }
145     }
146
147     /**
148      * Again, we prefix the stack trace with "ExceptionConverter:"
149      * @param s A PrintWriter object
150      */
151     public void printStackTrace(java.io.PrintWriter JavaDoc s) {
152         if (ex == null)
153             super.printStackTrace(s);
154         else {
155             synchronized (s) {
156                 s.print(split(getClass().getName()) + ": ");
157                 ex.printStackTrace(s);
158             }
159         }
160     }
161
162     /**
163      * Removes everything in a String that comes before a '.'
164      * @param s the original string
165      * @return the part that comes after the dot
166      */
167     private static String JavaDoc split(String JavaDoc s) {
168         int i = s.lastIndexOf('.');
169         if (i < 0)
170             return s;
171         else
172             return s.substring(i + 1);
173     }
174 }
175
Popular Tags