Source code: org/jdom/IllegalNameException.java
1 /*--
2
3 $Id: IllegalNameException.java,v 1.13 2004/02/06 09:28:30 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;
58
59 /**
60 * Thrown when a name is supplied in construction of a JDOM construct whose
61 * where the name breaks XML naming conventions.
62 *
63 * @version $Revision: 1.13 $, $Date: 2004/02/06 09:28:30 $
64 * @author Brett McLaughlin
65 * @author Elliotte Rusty Harold
66 */
67 public class IllegalNameException extends IllegalArgumentException {
68
69 private static final String CVS_ID =
70 "@(#) $RCSfile: IllegalNameException.java,v $ $Revision: 1.13 $ $Date: 2004/02/06 09:28:30 $ $Name: jdom_1_0 $";
71
72 /**
73 * This will create an <code>Exception</code> indicating
74 * that the specified name is illegal for the construct
75 * it was supplied to.
76 *
77 * @param name <code>String</code> name that breaks rules.
78 * @param construct <code>String</code> name of JDOM construct
79 * that <code>name</code> was supplied to.
80 * @param reason <code>String</code> message or reason name is illegal.
81 */
82 IllegalNameException(String name, String construct, String reason) {
83 super(new StringBuffer()
84 .append("The name \"")
85 .append(name)
86 .append("\" is not legal for JDOM/XML ")
87 .append(construct)
88 .append("s: ")
89 .append(reason)
90 .append(".")
91 .toString());
92 }
93
94 /**
95 * This will create an <code>Exception</code> indicating
96 * that the specified name is illegal for the construct
97 * it was supplied to.
98 *
99 * @param name <code>String</code> name that breaks rules.
100 * @param construct <code>String</code> name of JDOM construct
101 * that <code>name</code> was supplied to.
102 */
103 IllegalNameException(String name, String construct) {
104 super(new StringBuffer()
105 .append("The name \"")
106 .append(name)
107 .append("\" is not legal for JDOM/XML ")
108 .append(construct)
109 .append("s.")
110 .toString());
111 }
112
113 /**
114 * Creates an exception with the specified error message.
115 *
116 * @param reason cause of the problem
117 */
118 public IllegalNameException(String reason) {
119 super(reason);
120 }
121 }