DOMWriter.hpp

Go to the documentation of this file.

#ifndef DOMWriter_HEADER_GUARD_
#define DOMWriter_HEADER_GUARD_

/*
 * Copyright 2002,2004 The Apache Software Foundation.
 * 
 * Licensed 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: DOMWriter.hpp 231323 2005-08-10 20:58:40Z cargilld $
 */

#include <xercesc/dom/DOMNode.hpp>
#include <xercesc/dom/DOMWriterFilter.hpp>
#include <xercesc/dom/DOMErrorHandler.hpp>
#include <xercesc/framework/XMLFormatter.hpp>

XERCES_CPP_NAMESPACE_BEGIN

class CDOM_EXPORT DOMWriter {
protected :
    // -----------------------------------------------------------------------
    //  Hidden constructors
    // -----------------------------------------------------------------------
    DOMWriter() {};
private:        
    // -----------------------------------------------------------------------
    // Unimplemented constructors and operators
    // -----------------------------------------------------------------------
    DOMWriter(const DOMWriter &);
    DOMWriter & operator = (const DOMWriter &);


public:
    // -----------------------------------------------------------------------
    //  All constructors are hidden, just the destructor is available
    // -----------------------------------------------------------------------
    virtual ~DOMWriter() {};

    // -----------------------------------------------------------------------
    //  Virtual DOMWriter interface
    // -----------------------------------------------------------------------
    // -----------------------------------------------------------------------
    //  Feature methods
    // -----------------------------------------------------------------------
    virtual bool           canSetFeature(const XMLCh* const featName
                                       , bool               state) const = 0;
    virtual void            setFeature(const XMLCh* const featName
                                     , bool               state) = 0;

    virtual bool               getFeature(const XMLCh* const featName) const = 0;

    // -----------------------------------------------------------------------
    //  Setter methods
    // -----------------------------------------------------------------------
    virtual void           setEncoding(const XMLCh* const encoding) = 0;

    virtual void          setNewLine(const XMLCh* const newLine) = 0;

    virtual void         setErrorHandler(DOMErrorHandler *errorHandler) = 0;

    virtual void         setFilter(DOMWriterFilter *filter) = 0;

    // -----------------------------------------------------------------------
    //  Getter methods
    // -----------------------------------------------------------------------
     virtual const XMLCh*       getEncoding() const = 0;

     virtual const XMLCh*       getNewLine() const = 0;

     virtual DOMErrorHandler*   getErrorHandler() const = 0;

     virtual DOMWriterFilter*   getFilter() const = 0;

    // -----------------------------------------------------------------------
    //  Write methods
    // -----------------------------------------------------------------------
    virtual bool       writeNode(XMLFormatTarget* const destination
                               , const DOMNode         &nodeToWrite) = 0;

    virtual XMLCh*     writeToString(const DOMNode &nodeToWrite) = 0;


    // -----------------------------------------------------------------------
    //  Non-standard Extension
    // -----------------------------------------------------------------------
    virtual void              release() = 0;


};

XERCES_CPP_NAMESPACE_END

#endif

---