Xerces-C++ 3.2.4

DOMLSOutput.hpp
Go to the documentation of this file.
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18/*
19 * $Id$
20 */
21
22#if !defined(XERCESC_INCLUDE_GUARD_DOMLSOUTPUT_HPP)
23#define XERCESC_INCLUDE_GUARD_DOMLSOUTPUT_HPP
24
25#include <xercesc/util/XercesDefs.hpp>
26
27 XERCES_CPP_NAMESPACE_BEGIN
28
29
30 class XMLFormatTarget;
31
32
39 class CDOM_EXPORT DOMLSOutput
40{
41 protected:
42 // -----------------------------------------------------------------------
43 // Hidden constructors
44 // -----------------------------------------------------------------------
47 DOMLSOutput() {};
49
50 private:
51 // -----------------------------------------------------------------------
52 // Unimplemented constructors and operators
53 // -----------------------------------------------------------------------
56 DOMLSOutput(const DOMLSOutput &);
57 DOMLSOutput & operator = (const DOMLSOutput &);
59
60 public:
61 // -----------------------------------------------------------------------
62 // All constructors are hidden, just the destructor is available
63 // -----------------------------------------------------------------------
70 virtual ~DOMLSOutput() {};
72
73 // -----------------------------------------------------------------------
74 // Virtual DOMLSOutput interface
75 // -----------------------------------------------------------------------
78 // -----------------------------------------------------------------------
79 // Getter methods
80 // -----------------------------------------------------------------------
86 virtual XMLFormatTarget* getByteStream() const = 0;
87
98 virtual const XMLCh* getEncoding() const = 0;
99
109 virtual const XMLCh* getSystemId() const = 0;
110
111 // -----------------------------------------------------------------------
112 // Setter methods
113 // -----------------------------------------------------------------------
119 virtual void setByteStream(XMLFormatTarget* stream) = 0;
120
133 virtual void setEncoding(const XMLCh* const encodingStr) = 0;
134
148 virtual void setSystemId(const XMLCh* const systemId) = 0;
150
151 // -----------------------------------------------------------------------
152 // Non-standard Extension
153 // -----------------------------------------------------------------------
162 virtual void release() = 0;
164};
165
166
167 XERCES_CPP_NAMESPACE_END
168
169#endif
XercesDefs.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
uint16_t XMLCh
Definition: Xerces_autoconf_config.hpp:120
DOMLSOutput
This interface represents an output destination for data.
Definition: DOMLSOutput.hpp:40
DOMLSOutput::getEncoding
virtual const XMLCh * getEncoding() const =0
An input source can be set to force the parser to assume a particular encoding for the data that inpu...
DOMLSOutput::~DOMLSOutput
virtual ~DOMLSOutput()
Destructor.
Definition: DOMLSOutput.hpp:70
DOMLSOutput::DOMLSOutput
DOMLSOutput()
Definition: DOMLSOutput.hpp:47
DOMLSOutput::getSystemId
virtual const XMLCh * getSystemId() const =0
Get the system identifier for this input source.
DOMLSOutput::setSystemId
virtual void setSystemId(const XMLCh *const systemId)=0
Set the system identifier for this input source.
DOMLSOutput::setEncoding
virtual void setEncoding(const XMLCh *const encodingStr)=0
Set the encoding which will be required for use with the XML text read via a stream opened by this in...
DOMLSOutput::release
virtual void release()=0
Called to indicate that this DOMLSOutput is no longer in use and that the implementation may relinqui...
DOMLSOutput::setByteStream
virtual void setByteStream(XMLFormatTarget *stream)=0
Sets the byte stream for this input source.
DOMLSOutput::getByteStream
virtual XMLFormatTarget * getByteStream() const =0
Returns the byte stream for this input source.
XMLFormatTarget
Definition: XMLFormatter.hpp:443