DOMLSSerializer.hpp

Go to the documentation of this file.

/*
 * 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: DOMLSSerializer.hpp 883665 2009-11-24 11:41:38Z borisk $
 */

#if !defined(XERCESC_INCLUDE_GUARD_DOMLSSERIALIZER_HPP)
#define XERCESC_INCLUDE_GUARD_DOMLSSERIALIZER_HPP

#include <xercesc/dom/DOMNode.hpp>
#include <xercesc/dom/DOMLSSerializerFilter.hpp>
#include <xercesc/dom/DOMErrorHandler.hpp>
#include <xercesc/dom/DOMConfiguration.hpp>

XERCES_CPP_NAMESPACE_BEGIN

class DOMLSOutput;

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


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

    // -----------------------------------------------------------------------
    //  Virtual DOMLSSerializer interface
    // -----------------------------------------------------------------------
    // -----------------------------------------------------------------------
    //  Feature methods
    // -----------------------------------------------------------------------
    virtual DOMConfiguration* getDomConfig() = 0;

    // -----------------------------------------------------------------------
    //  Setter methods
    // -----------------------------------------------------------------------
    virtual void          setNewLine(const XMLCh* const newLine) = 0;

    virtual void         setFilter(DOMLSSerializerFilter *filter) = 0;

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

     virtual DOMLSSerializerFilter*   getFilter() const = 0;

    // -----------------------------------------------------------------------
    //  Write methods
    // -----------------------------------------------------------------------
    virtual bool       write(const DOMNode*         nodeToWrite,
                             DOMLSOutput* const destination) = 0;

    virtual bool       writeToURI(const DOMNode*    nodeToWrite,
                                  const XMLCh*      uri) = 0;
    virtual XMLCh*     writeToString(const DOMNode* nodeToWrite, MemoryManager* manager = NULL) = 0;


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


};

XERCES_CPP_NAMESPACE_END

#endif