This class generates errors on any JSON events. More...

#include <UT_JSONHandle.h>

Inheritance diagram for UT_JSONHandleError:

Public Member Functions
	UT_JSONHandleError (bool fatal=true)

	~UT_JSONHandleError () override

	UT_JSONHandleError (const UT_JSONHandleError &)=delete

UT_JSONHandleError &	operator= (const UT_JSONHandleError &)=delete

virtual const char *	getClassName () const

bool	jsonNull (UT_JSONParser &p) override
	Event method to process a null token. More...

bool	jsonBool (UT_JSONParser &p, bool value) override
	Event method to process a bool (true or false tokens) More...

bool	jsonInt (UT_JSONParser &p, int64 value) override
	Event method to process an integer. More...

bool	jsonReal (UT_JSONParser &p, fpreal64 value) override
	Event method to process a real/float. More...

bool	jsonString (UT_JSONParser &p, const char *v, int64 len) override
	Event method to process a string value. More...

bool	jsonKey (UT_JSONParser &p, const char *v, int64 len) override
	Event method to process the key of a map/object is read. More...

bool	jsonBeginMap (UT_JSONParser &p) override
	Event method invoked at the start of a map/object. More...

bool	jsonEndMap (UT_JSONParser &p) override
	Event method invoked at the end of a map/object. More...

bool	jsonBeginArray (UT_JSONParser &p) override
	Event method invoked at the beginning of an array object. More...

bool	jsonEndArray (UT_JSONParser &p) override
	Event method invoked at the end of an array object. More...

Public Member Functions inherited from UT_JSONHandle
	UT_JSONHandle ()

virtual	~UT_JSONHandle ()

	UT_JSONHandle (const UT_JSONHandle &)=delete

UT_JSONHandle &	operator= (const UT_JSONHandle &)=delete

bool	parseObject (UT_JSONParser &p, UT_IStream *is=0)
	Convenience method to parse a single object. More...

virtual bool	jsonStringHolder (UT_JSONParser &p, const UT_StringHolder &s)

virtual bool	jsonKeyHolder (UT_JSONParser &p, const UT_StringHolder &s)

virtual bool	uaBool (UT_JSONParser &p, int64 length)

virtual bool	uaInt8 (UT_JSONParser &p, int64 length)
	Event method to handle uniform array of int8 data. More...

virtual bool	uaInt16 (UT_JSONParser &p, int64 length)
	Event method to handle uniform array of int16 data. More...

virtual bool	uaInt32 (UT_JSONParser &p, int64 length)
	Event method to handle uniform array of int32 data. More...

virtual bool	uaInt64 (UT_JSONParser &p, int64 length)
	Event method to handle uniform array of int64 data. More...

virtual bool	uaReal16 (UT_JSONParser &p, int64 length)
	Event method to handle uniform array of real16 data. More...

virtual bool	uaReal32 (UT_JSONParser &p, int64 length)
	Event method to handle uniform array of real32 data. More...

virtual bool	uaReal64 (UT_JSONParser &p, int64 length)
	Event method to handle uniform array of real64 data. More...

virtual bool	uaUInt8 (UT_JSONParser &p, int64 length)
	Event method to handle uniform array of unsigned uint8 data. More...

virtual bool	uaUInt16 (UT_JSONParser &p, int64 length)
	Event method to handle uniform array of unsigned uint16 data. More...

virtual bool	uaString (UT_JSONParser &p, int64 length)
	Event method to handle uniform array of string data (use uaReadString) More...

virtual bool	uaStringToken (UT_JSONParser &p, int64 length)

virtual void	errorPrefix (UT_JSONParser &p, UT_WorkBuffer &msg)

Protected Member Functions
virtual bool	typeError (UT_JSONParser &p, const char *name)
	Add a type error for the given name. More...

bool	getFatal () const
	Check whether errors should be fatal (or just warnings) More...

void	setFatal (bool f)
	Set whether errors should be fatal (or just warnings) More...

Protected Member Functions inherited from UT_JSONHandle
bool	isKey (const char s1, const char s2) const
	Convenience method to test key values. More...

void	skipBadKey (UT_JSONParser &p, const char *key)

void	fatalBadKey (UT_JSONParser &p, const char *key)

Additional Inherited Members
Static Public Member Functions inherited from UT_JSONHandle
static UT_JSONHandle *	getNullHandle ()

static void	releaseNullHandle (UT_JSONHandle *h)
	Instead of deleting the null handle, please call releaseNullHandle() More...

Detailed Description

This class generates errors on any JSON events.

The UT_JSONHandleError class will throw errors on any JSON events. It's useful as a base class for an event handler which only expects certain events. For example, if you only expect the keyword argument, you might have a class like:

class MyHandle : public UT_JSONHandleError {
    virtual bool jsonKey(UT_JSONParser &p, const char *v, int64 len);
    virtual const char   *className() { return "MyClass" }
}

The base class would handle trapping errors on anything other than a map key.

Note: Uniform arrays are handled by the UT_JSONHandle base class

See Also: UT_JSONHandle, UT_JSONHandleNull

Definition at line 155 of file UT_JSONHandle.h.

Constructor & Destructor Documentation

UT_JSONHandleError::UT_JSONHandleError ( bool fatal = true )

inline

Parameters

fatal If fatal is true then errors will cause parsing to terminate. Otherwise, parsing will continue and errors will cascade.

Definition at line 160 of file UT_JSONHandle.h.

UT_JSONHandleError::~UT_JSONHandleError ( )

inlineoverride

Definition at line 161 of file UT_JSONHandle.h.

UT_JSONHandleError::UT_JSONHandleError ( const UT_JSONHandleError & )

delete

Member Function Documentation

virtual const char* UT_JSONHandleError::getClassName ( ) const

virtual

getClassName() should return a meaningful label. The errors generated will be: Error parsing s: Unexpected "type" JSON object The default is an empty string.

bool UT_JSONHandleError::getFatal ( ) const

inlineprotected

Check whether errors should be fatal (or just warnings)

Definition at line 186 of file UT_JSONHandle.h.

bool UT_JSONHandleError::jsonBeginArray ( UT_JSONParser & p )

overridevirtual

Event method invoked at the beginning of an array object.

Implements UT_JSONHandle.

bool UT_JSONHandleError::jsonBeginMap ( UT_JSONParser & p )

overridevirtual

Event method invoked at the start of a map/object.

Implements UT_JSONHandle.