/*

* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description: 

*

*/

#ifndef DOMNotation_HEADER_GUARD_

#define DOMNotation_HEADER_GUARD_

/*

 * Licensed to the Apache Software Foundation (ASF) under one or more

 * contributor license agreements.  See the NOTICE file distributed with

 * this work for additional information regarding copyright ownership.

 * The ASF licenses this file to You under the Apache License, Version 2.0

 * (the "License"); you may not use this file except in compliance with

 * the License.  You may obtain a copy of the License at

 * 

 *      http://www.apache.org/licenses/LICENSE-2.0

 * 

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

/*

 * $Id: DOMNotation.hpp 568078 2007-08-21 11:43:25Z amassari $

 */

#include <xercesc/util/XercesDefs.hpp>

#include <xercesc/dom/DOMNode.hpp>

XERCES_CPP_NAMESPACE_BEGIN

/**

 * This interface represents a notation declared in the DTD. A notation either

 * declares, by name, the format of an unparsed entity (see section 4.7 of

 * the XML 1.0 specification), or is used for formal declaration of

 * Processing Instruction targets (see section 2.6 of the XML 1.0

 * specification). The <code>nodeName</code> attribute inherited from

 * <code>DOMNode</code> is set to the declared name of the notation.

 * <p>The DOM Level 1 does not support editing <code>DOMNotation</code> nodes;

 * they are therefore readonly.

 * <p>A <code>DOMNotation</code> node does not have any parent.

 *

 * @since DOM Level 1

 */

class CDOM_EXPORT DOMNotation: public DOMNode {

protected:

    // -----------------------------------------------------------------------

    //  Hidden constructors

    // -----------------------------------------------------------------------

    /** @name Hidden constructors */

    //@{    

    DOMNotation() {}

    DOMNotation(const DOMNotation &other) : DOMNode(other) {}

    //@}

private:

    // -----------------------------------------------------------------------

    // Unimplemented constructors and operators

    // -----------------------------------------------------------------------

    /** @name Unimplemented operators */

    //@{

    DOMNotation & operator = (const DOMNotation &);

    //@}

public:

    // -----------------------------------------------------------------------

    //  All constructors are hidden, just the destructor is available

    // -----------------------------------------------------------------------

    /** @name Destructor */

    //@{

    /**

     * Destructor

     *

     */

    virtual ~DOMNotation() {};

    //@}

    // -----------------------------------------------------------------------

    //  Virtual DOMNotation interface

    // -----------------------------------------------------------------------

    /** @name Functions introduced in DOM Level 1 */

    //@{

    // -----------------------------------------------------------------------

    //  Getter methods

    // -----------------------------------------------------------------------

    /**

     * Get the public identifier of this notation.

     *

     * If the  public identifier was not

     * specified, this is <code>null</code>.

     * @return Returns the public identifier of the notation

     * @since DOM Level 1

     */

    virtual const XMLCh *getPublicId() const = 0;

    /**

     * Get the system identifier of this notation.

     *

     * If the  system identifier was not

     * specified, this is <code>null</code>.

     * @return Returns the system identifier of the notation

     * @since DOM Level 1

     */

    virtual const XMLCh *getSystemId() const = 0;

    //@}

};

XERCES_CPP_NAMESPACE_END

#endif