DOMLSInput.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_DOMLSINPUT_HPP)
#define XERCESC_INCLUDE_GUARD_DOMLSINPUT_HPP
#include <xercesc/util/XercesDefs.hpp>
XERCES_CPP_NAMESPACE_BEGIN
class InputSource;
class CDOM_EXPORT DOMLSInput
{
protected:
// -----------------------------------------------------------------------
// Hidden constructors
// -----------------------------------------------------------------------
DOMLSInput() {};
private:
// -----------------------------------------------------------------------
// Unimplemented constructors and operators
// -----------------------------------------------------------------------
DOMLSInput(const DOMLSInput &);
DOMLSInput & operator = (const DOMLSInput &);
public:
// -----------------------------------------------------------------------
// All constructors are hidden, just the destructor is available
// -----------------------------------------------------------------------
virtual ~DOMLSInput() {};
// -----------------------------------------------------------------------
// Virtual DOMLSInput interface
// -----------------------------------------------------------------------
// -----------------------------------------------------------------------
// Getter methods
// -----------------------------------------------------------------------
virtual const XMLCh* getStringData() const = 0;
virtual InputSource* getByteStream() const = 0;
virtual const XMLCh* getEncoding() const = 0;
virtual const XMLCh* getPublicId() const = 0;
virtual const XMLCh* getSystemId() const = 0;
virtual const XMLCh* getBaseURI() const = 0;
// -----------------------------------------------------------------------
// Setter methods
// -----------------------------------------------------------------------
// -----------------------------------------------------------------------
virtual void setStringData(const XMLCh* data) = 0;
virtual void setByteStream(InputSource* stream) = 0;
virtual void setEncoding(const XMLCh* const encodingStr) = 0;
virtual void setPublicId(const XMLCh* const publicId) = 0;
virtual void setSystemId(const XMLCh* const systemId) = 0;
virtual void setBaseURI(const XMLCh* const baseURI) = 0;
// -----------------------------------------------------------------------
// Non-standard Extension
// -----------------------------------------------------------------------
virtual void setIssueFatalErrorIfNotFound(bool flag) = 0;
virtual bool getIssueFatalErrorIfNotFound() const = 0;
virtual void release() = 0;
};
XERCES_CPP_NAMESPACE_END
#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
DOMLSInput
This interface represents a single input source for an XML entity.
Definition: DOMLSInput.hpp:60
DOMLSInput::setIssueFatalErrorIfNotFound
virtual void setIssueFatalErrorIfNotFound(bool flag)=0
Indicates if the parser should issue fatal error if this input source is not found.
DOMLSInput::setBaseURI
virtual void setBaseURI(const XMLCh *const baseURI)=0
Set the base URI to be used for resolving relative URIs to absolute URIs.
DOMLSInput::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...
DOMLSInput::~DOMLSInput
virtual ~DOMLSInput()
Destructor.
Definition: DOMLSInput.hpp:90
DOMLSInput::getPublicId
virtual const XMLCh * getPublicId() const =0
Get the public identifier for this input source.
DOMLSInput::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...
DOMLSInput::setByteStream
virtual void setByteStream(InputSource *stream)=0
Sets the byte stream for this input source.
DOMLSInput::setSystemId
virtual void setSystemId(const XMLCh *const systemId)=0
Set the system identifier for this input source.
DOMLSInput::getSystemId
virtual const XMLCh * getSystemId() const =0
Get the system identifier for this input source.
DOMLSInput::setStringData
virtual void setStringData(const XMLCh *data)=0
Sets the UTF-16 string for this input source.
DOMLSInput::setPublicId
virtual void setPublicId(const XMLCh *const publicId)=0
Set the public identifier for this input source.
DOMLSInput::getByteStream
virtual InputSource * getByteStream() const =0
Returns the byte stream for this input source.
DOMLSInput::getIssueFatalErrorIfNotFound
virtual bool getIssueFatalErrorIfNotFound() const =0
Get the flag that indicates if the parser should issue fatal error if this input source is not found.
DOMLSInput::DOMLSInput
DOMLSInput()
Definition: DOMLSInput.hpp:67
DOMLSInput::getBaseURI
virtual const XMLCh * getBaseURI() const =0
Get the base URI to be used for resolving relative URIs to absolute URIs.
DOMLSInput::getStringData
virtual const XMLCh * getStringData() const =0
String data to parse.
DOMLSInput::release
virtual void release()=0
Called to indicate that this DOMLSInput is no longer in use and that the implementation may relinquis...
InputSource
A single input source for an XML entity.
Definition: InputSource.hpp:63