Base Framework
Public Member Functions | List of all members
XMLDefaultReader Class Reference

Support for reading an XML document using callbacks. More...

#include <base/xml/XMLDefaultReader.h>

Inherits XMLReader.

Public Member Functions

 XMLDefaultReader () noexcept
 
bool getFeature (const String &name) const
 
void setFeature (const String &name, bool value)
 
ContentHandler * getContentHandler () const noexcept
 
DTDHandlergetDTDHandler () const noexcept
 
EntityResolver * getEntityResolver () const noexcept
 
ErrorHandlergetErrorHandler () const noexcept
 
void parse (File file, const String &uri=String())
 
void parse (const char *buffer, unsigned int size, const String &uri)
 
void parse (const String &systemId)
 
void setContentHandler (ContentHandler *handler) noexcept
 
void setDTDHandler (DTDHandler *handler) noexcept
 
void setEntityResolver (EntityResolver *_entityResolver) noexcept
 
void setErrorHandler (ErrorHandler *handler) noexcept
 
bool getValidation () const noexcept
 
void setVatidation (bool validate) noexcept
 
bool isStandalone () const noexcept
 
void terminate () noexcept
 
 ~XMLDefaultReader () noexcept
 
- Public Member Functions inherited from XMLReader
virtual void setContentHandler (ContentHandler *handler) noexcept=0
 
virtual void setEntityResolver (EntityResolver *entityResolver) noexcept=0
 
- Public Member Functions inherited from Polymorphic
 Polymorphic () noexcept
 
virtual ~Polymorphic () noexcept
 

Detailed Description

Support for reading an XML document using callbacks.

Version
1.0

Constructor & Destructor Documentation

◆ XMLDefaultReader()

XMLDefaultReader::XMLDefaultReader ( )
noexcept

Initializes the XML reader.

◆ ~XMLDefaultReader()

XMLDefaultReader::~XMLDefaultReader ( )
noexcept

Destroys the XML reader.

Member Function Documentation

◆ getContentHandler()

ContentHandler* XMLDefaultReader::getContentHandler ( ) const
inlinevirtualnoexcept

Returns the current content handler.

Implements XMLReader.

◆ getDTDHandler()

DTDHandler* XMLDefaultReader::getDTDHandler ( ) const
inlinevirtualnoexcept

Returns the current DTD handler.

Implements XMLReader.

◆ getEntityResolver()

EntityResolver* XMLDefaultReader::getEntityResolver ( ) const
inlinevirtualnoexcept

Returns the current entity resolver.

Implements XMLReader.

◆ getErrorHandler()

ErrorHandler* XMLDefaultReader::getErrorHandler ( ) const
inlinevirtualnoexcept

Returns the current error handler.

Implements XMLReader.

◆ getFeature()

bool XMLDefaultReader::getFeature ( const String name) const
virtual

Returns the value of the specified feature.

Implements XMLReader.

◆ getValidation()

bool XMLDefaultReader::getValidation ( ) const
inlinevirtualnoexcept

Returns the validation flag.

Implements XMLReader.

◆ isStandalone()

bool XMLDefaultReader::isStandalone ( ) const
inlinevirtualnoexcept

Returns true if the document is a standalone document.

Implements XMLReader.

◆ parse() [1/3]

void XMLDefaultReader::parse ( const char *  buffer,
unsigned int  size,
const String uri 
)

Parses the specified buffer.

Parameters
bufferThe buffer to be parsed.
sizeThe size of the buffer.
uriThe uri used to resolve entities. Default is improper string.

◆ parse() [2/3]

void XMLDefaultReader::parse ( const String systemId)

Parses an XML document from a system identifier (URI).

Parameters
systemIdThe identifier of the document.

◆ parse() [3/3]

void XMLDefaultReader::parse ( File  file,
const String uri = String() 
)

Parses the specified file.

Parameters
fileThe file to be parsed.
uriThe uri used to resolve entities. Default is improper string.

◆ setContentHandler()

void XMLDefaultReader::setContentHandler ( ContentHandler *  handler)
inlinenoexcept

Registers a content event handler.

◆ setDTDHandler()

void XMLDefaultReader::setDTDHandler ( DTDHandler handler)
inlinevirtualnoexcept

Registers a DTD event handler.

Implements XMLReader.

◆ setEntityResolver()

void XMLDefaultReader::setEntityResolver ( EntityResolver *  _entityResolver)
inlinenoexcept

Registers an entity resolver.

◆ setErrorHandler()

void XMLDefaultReader::setErrorHandler ( ErrorHandler handler)
inlinevirtualnoexcept

Registers an error event handler.

Implements XMLReader.

◆ setFeature()

void XMLDefaultReader::setFeature ( const String name,
bool  value 
)
virtual

Sets the value of the specified feature.

Implements XMLReader.

◆ setVatidation()

void XMLDefaultReader::setVatidation ( bool  validate)
inlinevirtualnoexcept

Sets the validation flag.

Implements XMLReader.

◆ terminate()

void XMLDefaultReader::terminate ( )
virtualnoexcept

Terminates the parsing.

Implements XMLReader.