join::SaxHandler Class Reference

SAX API interface class. More...

#include <sax.hpp>

Inheritance diagram for join::SaxHandler:

Public Member Functions
	SaxHandler ()=default
	default constructor.
	SaxHandler (const SaxHandler &other)=default
	copy constructor.
SaxHandler &	operator= (const SaxHandler &other)=default
	copy assignment.
	SaxHandler (SaxHandler &&other)=default
	move constructor.
SaxHandler &	operator= (SaxHandler &&other)=default
	move assignment.
virtual	~SaxHandler ()=default
	destroy instance.
virtual int	setNull ()=0
	set null value.
virtual int	setBool (bool value)=0
	set boolean value.
virtual int	setInt (int32_t value)=0
	set integer value.
virtual int	setUint (uint32_t value)=0
	set unsigned integer value.
virtual int	setInt64 (int64_t value)=0
	set 64 bits integer value.
virtual int	setUint64 (uint64_t value)=0
	set unsigned 64 bits integer value.
virtual int	setDouble (double value)=0
	set real value.
virtual int	setString (const std::string &value)=0
	set string value.
virtual int	startArray (uint32_t size=0)=0
	start array.
virtual int	stopArray ()
	stop array.
virtual int	startObject (uint32_t size=0)=0
	start object.
virtual int	setKey (const std::string &key)=0
	set key.
virtual int	stopObject ()
	stop object.

Detailed Description

SAX API interface class.

Constructor & Destructor Documentation

SaxHandler() [1/3]

join::SaxHandler::SaxHandler ( )

default

default constructor.

SaxHandler() [2/3]

join::SaxHandler::SaxHandler ( const SaxHandler & other )

default

copy constructor.

Parameters

other

object to copy.

SaxHandler() [3/3]

join::SaxHandler::SaxHandler ( SaxHandler && other )

default

move constructor.

Parameters

other

object to move.

~SaxHandler()

virtual join::SaxHandler::~SaxHandler ( )

virtualdefault

destroy instance.

Member Function Documentation

operator=() [1/2]

SaxHandler & join::SaxHandler::operator= ( const SaxHandler & other )

default

copy assignment.

Parameters

other

object to copy.

Returns

a reference of the current object.

operator=() [2/2]

SaxHandler & join::SaxHandler::operator= ( SaxHandler && other )

default

move assignment.

Parameters

other

object to move.

Returns

a reference of the current object.

setBool()

virtual int join::SaxHandler::setBool ( bool value )

pure virtual

set boolean value.

Parameters

value

boolean value to set.

Returns

0 on success, -1 otherwise.

Implemented in join::JsonWriter, join::PackWriter, and join::StreamReader.

setDouble()

virtual int join::SaxHandler::setDouble ( double value )

pure virtual

set real value.

Parameters

value

real value to set.

Returns

0 on success, -1 otherwise.

Implemented in join::JsonCanonicalizer, join::JsonWriter, join::PackWriter, and join::StreamReader.

setInt()

virtual int join::SaxHandler::setInt ( int32_t value )

pure virtual

set integer value.

Parameters

value

integer value to set.

Returns

0 on success, -1 otherwise.

Implemented in join::JsonWriter, join::PackWriter, and join::StreamReader.

setInt64()

virtual int join::SaxHandler::setInt64 ( int64_t value )

pure virtual

set 64 bits integer value.

Parameters

value

64 bits integer value to set.

Returns

0 on success, -1 otherwise.

Implemented in join::JsonWriter, join::PackWriter, and join::StreamReader.

setKey()

virtual int join::SaxHandler::setKey ( const std::string & key )

pure virtual

set key.

Parameters

key	object key.

Returns

0 on success, -1 otherwise.

Implemented in join::JsonWriter, join::PackWriter, and join::StreamReader.

setNull()

virtual int join::SaxHandler::setNull ( )

pure virtual

set null value.

Returns

0 on success, -1 otherwise.

Implemented in join::JsonWriter, join::PackWriter, and join::StreamReader.

setString()

virtual int join::SaxHandler::setString ( const std::string & value )

pure virtual

set string value.

Parameters

value

string value to set.

Returns

0 on success, -1 otherwise.

Implemented in join::JsonWriter, join::PackWriter, and join::StreamReader.

setUint()

virtual int join::SaxHandler::setUint ( uint32_t value )

pure virtual

set unsigned integer value.

Parameters

value

unsigned integer value to set.

Returns

0 on success, -1 otherwise.

Implemented in join::JsonWriter, join::PackWriter, and join::StreamReader.

setUint64()

virtual int join::SaxHandler::setUint64 ( uint64_t value )

pure virtual

set unsigned 64 bits integer value.

Parameters

value

unsigned 64 bits integer value to set.

Returns

0 on success, -1 otherwise.

Implemented in join::JsonWriter, join::PackWriter, and join::StreamReader.

startArray()

virtual int join::SaxHandler::startArray ( uint32_t size = 0 )

pure virtual

start array.

Parameters

size	array size.

Returns

0 on success, -1 otherwise.

Implemented in join::JsonWriter, join::PackWriter, and join::StreamReader.

startObject()

virtual int join::SaxHandler::startObject ( uint32_t size = 0 )

pure virtual

start object.

Parameters

size	array size.

Returns

0 on success, -1 otherwise.

Implemented in join::JsonWriter, join::PackWriter, and join::StreamReader.

stopArray()

virtual int join::SaxHandler::stopArray ( )

inlinevirtual

stop array.

Returns

0 on success, -1 otherwise.

Reimplemented in join::JsonWriter, and join::StreamReader.

stopObject()

virtual int join::SaxHandler::stopObject ( )

inlinevirtual

stop object.

Returns

0 on success, -1 otherwise.

Reimplemented in join::JsonWriter, and join::StreamReader.

---

The documentation for this class was generated from the following file:

• data/include/join/sax.hpp