KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > nu > xom > UnavailableCharacterException


1 /* Copyright 2002-2004 Elliotte Rusty Harold
2    
3    This library is free software; you can redistribute it and/or modify
4    it under the terms of version 2.1 of the GNU Lesser General Public
5    License as published by the Free Software Foundation.
6    
7    This library is distributed in the hope that it will be useful,
8    but WITHOUT ANY WARRANTY; without even the implied warranty of
9    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10    GNU Lesser General Public License for more details.
11    
12    You should have received a copy of the GNU Lesser General Public
13    License along with this library; if not, write to the
14    Free Software Foundation, Inc., 59 Temple Place, Suite 330,
15    Boston, MA 02111-1307 USA
16    
17    You can contact Elliotte Rusty Harold by sending e-mail to
18    elharo@metalab.unc.edu. Please include the word "XOM" in the
19    subject line. The XOM home page is located at http://www.xom.nu/
20 */
21
22 package nu.xom;
23
24 /**
25  * <p>
26  * Thrown when serializing documents that contain characters not
27  * available in the current encoding, and which cannot be escaped
28  * (for instance, because they're in an element name or processing
29  * instruction data). This can never happen if the encoding is UTF-8
30  * or UTF-16.
31  * </p>
32  *
33  * @author Elliotte Rusty Harold
34  * @version 1.0
35  *
36  */
37 public class UnavailableCharacterException extends XMLException {
38
39     private char unavailableCharacter;
40     private String JavaDoc encoding;
41     
42     
43     /**
44      * <p>
45      * Creates a new <code>UnavailableCharacterException</code>.
46      * </p>
47      *
48      * @param character the character which caused the exception
49      * @param encoding the encoding which does not contain the character
50      */
51     public UnavailableCharacterException(char character, String JavaDoc encoding) {
52     
53         super("Cannot use the character " + character + " (&#x"
54           + Integer.toHexString(character).toUpperCase() + ";) in the "
55           + encoding + " encoding.");
56         this.unavailableCharacter = character;
57         this.encoding = encoding;
58         
59     }
60
61     
62     /**
63      * <p>
64      * Returns the character which could not be written
65      * in the current encoding.
66      * </p>
67
68      * @return the character which caused the exception
69      */
70     public char getCharacter() {
71         return this.unavailableCharacter;
72     }
73     
74     
75     /**
76      * <p>
77      * Returns the encoding that does not support the character.
78      * </p>
79      *
80      * @return the encoding used by the serializer when the exception
81      * was thrown
82      */
83     public String JavaDoc getEncoding() {
84         return this.encoding;
85     }
86     
87     
88 }
Popular Tags