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$
*/
#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
DOMConfiguration.hpp
DOMErrorHandler.hpp
DOMLSSerializerFilter.hpp
DOMNode.hpp
CDOM_EXPORT
#define CDOM_EXPORT
Definition XercesDefs.hpp:166
XERCES_CPP_NAMESPACE_BEGIN
#define XERCES_CPP_NAMESPACE_BEGIN
Definition XercesDefs.hpp:112
XERCES_CPP_NAMESPACE_END
#define XERCES_CPP_NAMESPACE_END
Definition XercesDefs.hpp:113
XMLCh
char16_t XMLCh
Definition Xerces_autoconf_config.hpp:120
DOMConfiguration
The DOMConfiguration interface represents the configuration of a document and maintains a table of re...
Definition DOMConfiguration.hpp:351
DOMLSOutput
This interface represents an output destination for data.
Definition DOMLSOutput.hpp:40
DOMLSSerializerFilter
DOMLSSerializerFilter.hpp: interface for the DOMLSSerializerFilter class.
Definition DOMLSSerializerFilter.hpp:47
DOMLSSerializer
Definition DOMLSSerializer.hpp:276
DOMLSSerializer::getFilter
virtual DOMLSSerializerFilter * getFilter() const =0
Return the WriterFilter used.
DOMLSSerializer::DOMLSSerializer
DOMLSSerializer()
Definition DOMLSSerializer.hpp:283
DOMLSSerializer::~DOMLSSerializer
virtual ~DOMLSSerializer()
Destructor.
Definition DOMLSSerializer.hpp:306
DOMLSSerializer::setNewLine
virtual void setNewLine(const XMLCh *const newLine)=0
The end-of-line sequence of characters to be used in the XML being written out.
DOMLSSerializer::write
virtual bool write(const DOMNode *nodeToWrite, DOMLSOutput *const destination)=0
Write out the specified node as described above in the description of DOMLSSerializer.
DOMLSSerializer::setFilter
virtual void setFilter(DOMLSSerializerFilter *filter)=0
When the application provides a filter, the serializer will call out to the filter before serializing...
DOMLSSerializer::writeToURI
virtual bool writeToURI(const DOMNode *nodeToWrite, const XMLCh *uri)=0
Write out the specified node as described above in the description of DOMLSSerializer.
DOMLSSerializer::getNewLine
virtual const XMLCh * getNewLine() const =0
Return the end-of-line sequence of characters to be used in the XML being written out.
DOMLSSerializer::getDomConfig
virtual DOMConfiguration * getDomConfig()=0
The DOMConfiguration object used by the LSSerializer when serializing a DOM node.
DOMLSSerializer::release
virtual void release()=0
Called to indicate that this Writer is no longer in use and that the implementation may relinquish an...
DOMLSSerializer::writeToString
virtual XMLCh * writeToString(const DOMNode *nodeToWrite, MemoryManager *manager=NULL)=0
Serialize the specified node as described above in the description of DOMLSSerializer.
DOMNode
The DOMNode interface is the primary datatype for the entire Document Object Model.
Definition DOMNode.hpp:139
MemoryManager
Configurable memory manager.
Definition MemoryManager.hpp:40