Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.4

Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

XSLException.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights 
00006  * reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. The end-user documentation included with the redistribution,
00021  *    if any, must include the following acknowledgment:  
00022  *       "This product includes software developed by the
00023  *        Apache Software Foundation (http://www.apache.org/)."
00024  *    Alternately, this acknowledgment may appear in the software itself,
00025  *    if and wherever such third-party acknowledgments normally appear.
00026  *
00027  * 4. The names "Xalan" and "Apache Software Foundation" must
00028  *    not be used to endorse or promote products derived from this
00029  *    software without prior written permission. For written 
00030  *    permission, please contact apache@apache.org.
00031  *
00032  * 5. Products derived from this software may not be called "Apache",
00033  *    nor may "Apache" appear in their name, without prior written
00034  *    permission of the Apache Software Foundation.
00035  *
00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047  * SUCH DAMAGE.
00048  * ====================================================================
00049  *
00050  * This software consists of voluntary contributions made by many
00051  * individuals on behalf of the Apache Software Foundation and was
00052  * originally based on software copyright (c) 1999, International
00053  * Business Machines, Inc., http://www.ibm.com.  For more
00054  * information on the Apache Software Foundation, please see
00055  * <http://www.apache.org/>.
00056  */
00057 #if !defined(XSLEXCEPTION_HEADER_GUARD_1357924680)
00058 #define XSLEXCEPTION_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <PlatformSupport/PlatformSupportDefinitions.hpp>
00064 
00065 
00066 
00067 #include <PlatformSupport/DOMStringHelper.hpp>
00068 #include <PlatformSupport/XalanLocator.hpp>
00069 
00070 
00071 
00072 class XALAN_PLATFORMSUPPORT_EXPORT XSLException
00073 {
00074 public:
00075 
00076     typedef XalanLocator::size_type     size_type;
00077 
00087     XSLException(
00088             const XalanDOMString&   theMessage,
00089             const XalanDOMString&   theURI,
00090             int                     theLineNumber,
00091             int                     theColumnNumber,
00092             const XalanDOMString&   theType = XalanDOMString(XALAN_STATIC_UCODE_STRING("XSLException")));
00093 
00101     XSLException(
00102             const Locator&          theLocator,
00103             const XalanDOMString&   theMessage,
00104             const XalanDOMString&   theType = XalanDOMString(XALAN_STATIC_UCODE_STRING("XSLException")));
00105 
00112     XSLException(
00113             const XalanDOMString&   theMessage,
00114             const XalanDOMString&   theType = XalanDOMString(XALAN_STATIC_UCODE_STRING("XSLException")));
00115 
00116     virtual
00117     ~XSLException();
00118 
00124     const XalanDOMString&
00125     getType() const
00126     {
00127         return m_type;
00128     }
00129 
00135     const XalanDOMString&
00136     getMessage() const
00137     {
00138         return m_message;
00139     }
00140 
00146     const XalanDOMString&
00147     getURI() const
00148     {
00149         return m_uri;
00150     }
00151 
00157     size_type
00158     getLineNumber() const
00159     {
00160         return m_lineNumber;
00161     }
00162 
00168     size_type
00169     getColumnNumber() const
00170     {
00171         return m_columnNumber;
00172     }
00173 
00174     XalanDOMString
00175     defaultFormat() const;
00176 
00177     void
00178     defaultFormat(XalanDOMString&   theBuffer) const;
00179 
00180     static void
00181     defaultFormat(
00182             const XalanDOMString&   theMessage,
00183             const XalanDOMString&   theURI,
00184             size_type               theLineNumber,
00185             size_type               theColumnNumber,
00186             const XalanDOMString&   theType,
00187             XalanDOMString&         theBuffer);
00188 
00189 private:
00190     
00191     const XalanDOMString    m_message;
00192     const XalanDOMString    m_uri;
00193 
00194     const size_type         m_lineNumber;
00195     const size_type         m_columnNumber;
00196 
00197     const XalanDOMString    m_type;
00198 };
00199 
00200 
00201 
00202 #endif  // XSLEXCEPTION_HEADER_GUARD_1357924680

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.4
Copyright © 2000, 2001, 2002 The Apache Software Foundation. All Rights Reserved.