DOMErrorImpl.hpp
上传用户:zhuqijet
上传日期:2013-06-25
资源大小:10074k
文件大小:9k
源码类别:

词法分析

开发平台:

Visual C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 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.  * $Log: DOMErrorImpl.hpp,v $
  58.  * Revision 1.7  2003/05/15 15:56:24  gareth
  59.  * Removed unnecessary include.
  60.  *
  61.  * Revision 1.6  2003/05/14 18:06:53  gareth
  62.  * Updated DOMError to http://www.w3.org/TR/2003/WD-DOM-Level-3-Core-20030226/core.html.
  63.  *
  64.  * Revision 1.5  2003/03/07 18:07:17  tng
  65.  * Return a reference instead of void for operator=
  66.  *
  67.  * Revision 1.4  2002/11/04 15:07:34  tng
  68.  * C++ Namespace Support.
  69.  *
  70.  * Revision 1.3  2002/07/15 19:25:49  tng
  71.  * DOM L3:  declare a dummy DOMError::set/getRelatedException
  72.  *
  73.  * Revision 1.2  2002/05/30 19:26:00  knoaman
  74.  * documentation update
  75.  *
  76.  * Revision 1.1  2002/05/23 15:47:24  knoaman
  77.  * DOM L3 core - support for DOMError, DOMErrorHandler and DOMLocator
  78.  *
  79.  */
  80. #ifndef DOMERRORIMPL_HPP
  81. #define DOMERRORIMPL_HPP
  82. #include <xercesc/dom/DOMError.hpp>
  83. #include <xercesc/util/XMLString.hpp>
  84. XERCES_CPP_NAMESPACE_BEGIN
  85. /**
  86.   * Introduced in DOM Level 3
  87.   * Implementation of a DOMError interface.
  88.   *
  89.   * @see DOMError#DOMError
  90.   */
  91. class CDOM_EXPORT DOMErrorImpl : public DOMError
  92. {
  93. public:
  94.     /** @name Constructors and Destructor */
  95.     //@{
  96.     /** Constructors */
  97.     DOMErrorImpl(const short severity);
  98.     DOMErrorImpl
  99.     (
  100.         const short severity
  101.         , const XMLCh* const message
  102.         , DOMLocator* const location
  103.     );
  104.     DOMErrorImpl
  105.     (
  106.         const short severity
  107.         , const XMLCh* type
  108.         , const XMLCh* message
  109.         , void* relatedData 
  110.         , bool adoptRelatedData = false
  111.     );
  112.     /** Desctructor */
  113.     virtual ~DOMErrorImpl();
  114.     //@}
  115.     /** @name Get function */
  116.     //@{
  117.    /**
  118.     * <p><b>"Experimental - subject to change"</b></p>
  119.     *
  120.     * Get the severity of the error
  121.     */
  122.     virtual short getSeverity() const;
  123.    /**
  124.     * <p><b>"Experimental - subject to change"</b></p>
  125.     *
  126.     * Get the message describing the error that occured.
  127.     */
  128.     virtual const XMLCh* getMessage() const;
  129.    /**
  130.     * <p><b>"Experimental - subject to change"</b></p>
  131.     *
  132.     * Get the location of the error
  133.     */
  134.     virtual DOMLocator* getLocation() const;
  135.     /**
  136.      * The related platform dependent exception if any.
  137.      *
  138.      * <p><b>"Experimental - subject to change"</b></p>
  139.      *
  140.      * @see   setRelatedException
  141.      * @since DOM Level 3
  142.      */
  143.     virtual void* getRelatedException() const;
  144.     virtual const XMLCh* getType() const;
  145.     virtual void* getRelatedData() const;
  146.     //@}
  147.    /** @name Set function */
  148.     //@{
  149.    /**
  150.     * <p><b>"Experimental - subject to change"</b></p>
  151.     *
  152.     * Set the severity of the error
  153.     *
  154.     * @param severity the type of the error to set
  155.     */
  156.     virtual void setSeverity(const short severity);
  157.    /**
  158.     * <p><b>"Experimental - subject to change"</b></p>
  159.     *
  160.     * Set the error message
  161.     *
  162.     * @param message the error message to set.
  163.     */
  164.     virtual void setMessage(const XMLCh* const message);
  165.    /**
  166.     * <p><b>"Experimental - subject to change"</b></p>
  167.     *
  168.     * Set the location of the error
  169.     *
  170.     * @param location the location of the error to set.
  171.     */
  172.     virtual void setLocation(DOMLocator* const location);
  173.    /**
  174.     * @param value <code>true</code> if DOMLocator is owned and should be
  175.     *              deleted, <code>false</code> otherwise.
  176.     */
  177.     void setAdoptLocation(const bool value);
  178.     /**
  179.      * The related platform dependent exception if any.
  180.      *
  181.      * <p><b>"Experimental - subject to change"</b></p>
  182.      *
  183.      * @param exception the related exception to set.
  184.      * @see   getRelatedException
  185.      * @since DOM Level 3
  186.      */
  187.     virtual void setRelatedException(void* exception) const;
  188.     virtual void setType(const XMLCh* type);
  189.     virtual void setRelatedData(void* relatedData);
  190.     /**
  191.      * @param value <code>true</code> if RelatedData is owned and should be
  192.      *              deleted, <code>false</code> otherwise.
  193.      */
  194.     void setAdoptRelatedData(bool adoptRelatedData);
  195.     //@}
  196. private :
  197.     /* Unimplemented constructors and operators */
  198.     /* Copy constructor */
  199.     DOMErrorImpl(const DOMErrorImpl&);
  200.     /* Assignment operator */
  201.     DOMErrorImpl& operator=(const DOMErrorImpl&);
  202.     // -----------------------------------------------------------------------
  203.     //  Private data members
  204.     //
  205.     //  fAdoptLocation
  206.     //      Indicates whether we own the DOMLocator object or not.
  207.     //
  208.     //  fSeverity
  209.     //      The type of the error.
  210.     //
  211.     //  fMessage
  212.     //      The error message.
  213.     //
  214.     //  fLocation
  215.     //      The location info of the error.
  216.     //
  217.     //  fType
  218.     //      The type of the error.
  219.     //
  220.     //  fRelatedData
  221.     //      The data related to this error.
  222.     //
  223.     //  fAdoptRelatedData
  224.     //      Indicates whether we own the fRelatedData object or not.
  225.     // -----------------------------------------------------------------------
  226.     bool         fAdoptLocation;
  227.     short        fSeverity;
  228.     const XMLCh* fMessage;
  229.     DOMLocator*  fLocation;
  230.     const XMLCh* fType;
  231.     void*        fRelatedData;
  232.     bool         fAdoptRelatedData;
  233. };
  234. // ---------------------------------------------------------------------------
  235. //  DOMErrorImpl: Getter methods
  236. // ---------------------------------------------------------------------------
  237. inline short DOMErrorImpl::getSeverity() const
  238. {
  239.     return fSeverity;
  240. }
  241. inline const XMLCh* DOMErrorImpl::getMessage() const
  242. {
  243.     return fMessage;
  244. }
  245. inline DOMLocator* DOMErrorImpl::getLocation() const
  246. {
  247.     return fLocation;
  248. }
  249. inline void* DOMErrorImpl::getRelatedException() const
  250. {
  251.     return 0;
  252. }
  253. inline const XMLCh* DOMErrorImpl::getType() const 
  254. {
  255.     return fType;
  256. }
  257. inline void* DOMErrorImpl::getRelatedData() const 
  258. {
  259.     return fRelatedData;
  260. }
  261. // ---------------------------------------------------------------------------
  262. //  DOMLocatorImpl: Setter methods
  263. // ---------------------------------------------------------------------------
  264. inline void DOMErrorImpl::setSeverity(const short severity)
  265. {
  266.     fSeverity = severity;
  267. }
  268. inline void DOMErrorImpl::setMessage(const XMLCh* const message)
  269. {
  270.     fMessage = message;
  271. }
  272. inline void DOMErrorImpl::setAdoptLocation(const bool value)
  273. {
  274.     fAdoptLocation = value;
  275. }
  276. inline void DOMErrorImpl::setType(const XMLCh* type)
  277. {
  278.     fType = type;
  279. }
  280. inline void DOMErrorImpl::setRelatedData(void* relatedData)
  281. {
  282.     fRelatedData = relatedData;
  283. }
  284. inline void DOMErrorImpl::setAdoptRelatedData(bool adoptRelatedData) {
  285.     fAdoptRelatedData = adoptRelatedData;
  286. }
  287. XERCES_CPP_NAMESPACE_END
  288. #endif