source: NonGTP/Xerces/xercesc/dom/deprecated/DOM_DOMException.hpp @ 188

Revision 188, 5.9 KB checked in by mattausch, 19 years ago (diff)

added xercesc to support

Line 
1/*
2 * The Apache Software License, Version 1.1
3 *
4 * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
5 * reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 *
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in
16 *    the documentation and/or other materials provided with the
17 *    distribution.
18 *
19 * 3. The end-user documentation included with the redistribution,
20 *    if any, must include the following acknowledgment:
21 *       "This product includes software developed by the
22 *        Apache Software Foundation (http://www.apache.org/)."
23 *    Alternately, this acknowledgment may appear in the software itself,
24 *    if and wherever such third-party acknowledgments normally appear.
25 *
26 * 4. The names "Xerces" and "Apache Software Foundation" must
27 *    not be used to endorse or promote products derived from this
28 *    software without prior written permission. For written
29 *    permission, please contact apache\@apache.org.
30 *
31 * 5. Products derived from this software may not be called "Apache",
32 *    nor may "Apache" appear in their name, without prior written
33 *    permission of the Apache Software Foundation.
34 *
35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46 * SUCH DAMAGE.
47 * ====================================================================
48 *
49 * This software consists of voluntary contributions made by many
50 * individuals on behalf of the Apache Software Foundation, and was
51 * originally based on software copyright (c) 1999, International
52 * Business Machines, Inc., http://www.ibm.com .  For more information
53 * on the Apache Software Foundation, please see
54 * <http://www.apache.org/>.
55 */
56
57/*
58 * $Id: DOM_DOMException.hpp,v 1.3 2002/11/04 15:04:44 tng Exp $
59 */
60
61#ifndef DOM_DOMException_HEADER_GUARD_
62#define DOM_DOMException_HEADER_GUARD_
63
64#include <xercesc/util/XercesDefs.hpp>
65#include "DOMString.hpp"
66
67XERCES_CPP_NAMESPACE_BEGIN
68
69
70/**
71  * Encapsulate a general DOM error or warning.
72  *
73  * <p> The DOM will create and throw an instance of DOMException
74  * when an error condition is detected.  Exceptions can occur
75  * when an application directly manipulates the DOM document
76  * tree that is produced by the parser, or when a document tree
77  * is created from scratch using the DOM API.  DOM exceptions will
78  * not be generated by the parser while constructing a document
79  * tree from an XML source document.
80  *
81  * <p>Unlike the other classes in the C++ DOM API, DOM_DOMException
82  * is NOT a reference to an underlying implementation class, and
83  * does not provide automatic memory management.  Code that catches
84  * a DOM exception is responsible for deleting it, or otherwise
85  * arranging for its disposal.
86  *
87  */
88class CDOM_EXPORT DOM_DOMException  {
89public:
90    /** @name Enumerators for DOM Exceptions */
91    //@{
92        enum ExceptionCode {
93                INDEX_SIZE_ERR       = 1,
94                DOMSTRING_SIZE_ERR   = 2,
95                HIERARCHY_REQUEST_ERR = 3,
96                WRONG_DOCUMENT_ERR   = 4,
97                INVALID_CHARACTER_ERR = 5,
98                NO_DATA_ALLOWED_ERR  = 6,
99                NO_MODIFICATION_ALLOWED_ERR = 7,
100                NOT_FOUND_ERR        = 8,
101                NOT_SUPPORTED_ERR    = 9,
102                INUSE_ATTRIBUTE_ERR  = 10,
103                INVALID_STATE_ERR    = 11,
104                SYNTAX_ERR           = 12,
105                INVALID_MODIFICATION_ERR    = 13,
106                NAMESPACE_ERR        = 14,
107                INVALID_ACCESS_ERR   = 15
108        };
109    //@}
110public:
111    /** @name Constructors and assignment operator */
112    //@{
113    /**
114      * Default constructor for DOM_DOMException.
115      *
116      */
117    DOM_DOMException();
118
119    /**
120      * Constructor which takes an error code and a message.
121      *
122      * @param code The error code which indicates the exception
123      * @param message The string containing the error message
124      */
125    DOM_DOMException(short code, const DOMString &message);
126
127    /**
128      * Copy constructor.
129      *
130      * @param other The object to be copied.
131      */
132    DOM_DOMException(const DOM_DOMException &other);
133
134    //@}
135    /** @name Destructor. */
136    //@{
137         /**
138          * Destructor for DOM_DOMException.  Applications are responsible
139      * for deleting DOM_Exception objects that they catch after they
140      * have completed their exception processing.
141          *
142          */
143    virtual ~DOM_DOMException();
144    //@}
145
146    /** @name Public variables. */
147     //@{
148         /**
149          * A code value, from the set defined by the ExceptionCode enum,
150      * indicating the type of error that occured.
151          */
152   ExceptionCode   code;
153
154         /**
155          * A string value.  Applications may use this field to hold an error
156      *  message.  The field value is not set by the DOM implementation,
157      *  meaning that the string will be empty when an exception is first
158      *  thrown.
159          */
160    DOMString msg;
161    //@}
162
163};
164
165XERCES_CPP_NAMESPACE_END
166
167#endif
168
Note: See TracBrowser for help on using the repository browser.