summaryrefslogtreecommitdiff
path: root/external/jaxp/source/gnu/xml/dom/DomEx.java
blob: 84a3a36c0eb4749ea416b2b0d0aadbf786e47bf2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/*
 * $Id: DomEx.java,v 1.1.1.1 2003-02-01 02:10:15 cbj Exp $
 * Copyright (C) 1999-2001 David Brownell
 * 
 * This file is part of GNU JAXP, a library.
 *
 * GNU JAXP is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * GNU JAXP is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * As a special exception, if you link this library with other files to
 * produce an executable, this library does not by itself cause the
 * resulting executable to be covered by the GNU General Public License.
 * This exception does not however invalidate any other reasons why the
 * executable file might be covered by the GNU General Public License. 
 */

package gnu.xml.dom;

import org.w3c.dom.*;


// $Id: DomEx.java,v 1.1.1.1 2003-02-01 02:10:15 cbj Exp $

/**
 * <p> DOMException implementation.   The version that
 * is provided by the W3C is abstract, so it can't be instantiated.
 *
 * <p> This also provides a bit more information about the error
 * that is being reported, in terms of the relevant DOM structures
 * and data.
 *
 * @author David Brownell 
 * @version $Date: 2003-02-01 02:10:15 $
 */
public class DomEx extends DOMException
{
    /** @serial Data that caused an error to be reported */
    private String data;

    /** @serial Node associated with the error. */
    private Node node;

    /** @serial Data associated with the error. */
    private int value;

    /**
     * Constructs an exception, with the diagnostic message
     * corresponding to the specified code.
     */
    public DomEx (short code)
    {
	super (code, diagnostic (code));
    }

    /**
     * Constructs an exception, with the diagnostic message
     * corresponding to the specified code and additional
     * information as provided.
     */
    public DomEx (short code, String data, Node node, int value)
    {
	super (code, diagnostic (code));
	this.data = data;
	this.node = node;
	this.value = value;
    }

    /** Returns the node to which the diagnotic applies, or null. */
    final public Node getNode () { return node; }

    /** Returns data to which the diagnotic applies, or null. */
    final public String getData () { return data; }

    /** Returns data to which the diagnotic applies, or null. */
    final public int getValue () { return value; }


    /**
     * Returns a diagnostic message that may be slightly more useful
     * than the generic one, where possible.
     */
    public String getMessage ()
    {
	String retval = super.getMessage ();

	if (data != null)
	    retval += "\nMore Information: " + data;
	if (value != 0)
	    retval += "\nNumber: " + value;
	if (node != null)
	    retval += "\nNode Name: " + node.getNodeName ();
	return retval;
    }


    // these strings should be localizable.

    private static String diagnostic (short code)
    {
	switch (code) {

	    // DOM L1:
	    case INDEX_SIZE_ERR:
		return "An index or size is out of range.";
	    case DOMSTRING_SIZE_ERR:
		return "A string is too big.";
	    case HIERARCHY_REQUEST_ERR:
		return "The node doesn't belong here.";
	    case WRONG_DOCUMENT_ERR:
		return "The node belongs in another document.";
	    case INVALID_CHARACTER_ERR:
		return "That character is not permitted.";
	    case NO_DATA_ALLOWED_ERR:
		return "This node does not permit data.";
	    case NO_MODIFICATION_ALLOWED_ERR:
		return "No changes are allowed.";
	    case NOT_FOUND_ERR:
		return "The node was not found in that context.";
	    case NOT_SUPPORTED_ERR:
		return "That object is not supported.";
	    case INUSE_ATTRIBUTE_ERR:
		return "The attribute belongs to a different element.";

	    // DOM L2:
	    case INVALID_STATE_ERR:
		return "The object is not usable.";
	    case SYNTAX_ERR:
		return "An illegal string was provided.";
	    case INVALID_MODIFICATION_ERR:
		return "An object's type may not be changed.";
	    case NAMESPACE_ERR:
		return "The operation violates XML Namespaces.";
	    case INVALID_ACCESS_ERR:
		return "Parameter or operation isn't supported by this node.";
	}
	return "Reserved exception number: " + code;
    }

}