Base interface for all JSON handlers. Types that need to be deserialized from JSON should implement IJsonHandler or a class that derives from it. As the JSON is parsed, the corresponding read... method to the token that was parsed will be called. These methods can return themselves or a different handler to handle the value. More...

#include <CesiumJsonReader/IJsonHandler.h>

Inheritance diagram for CesiumJsonReader::IJsonHandler:

Public Member Functions
virtual IJsonHandler *	readNull ()=0
	Called when the JSON parser encounters a `null`.

virtual IJsonHandler *	readBool (bool b)=0
	Called when the JSON parser encounters a boolean value.

virtual IJsonHandler *	readInt32 (int32_t i)=0
	Called when the JSON parser encounters an int32 value.

virtual IJsonHandler *	readUint32 (uint32_t i)=0
	Called when the JSON parser encounters a uint32 value.

virtual IJsonHandler *	readInt64 (int64_t i)=0
	Called when the JSON parser encounters an int64 value.

virtual IJsonHandler *	readUint64 (uint64_t i)=0
	Called when the JSON parser encounters a uint64 value.

virtual IJsonHandler *	readDouble (double d)=0
	Called when the JSON parser encounters a double value.

virtual IJsonHandler *	readString (const std::string_view &str)=0
	Called when the JSON parser encounters a string value.

virtual IJsonHandler *	readObjectStart ()=0
	Called when the JSON parser encounters the beginning of an object.

virtual IJsonHandler *	readObjectKey (const std::string_view &str)=0
	Called when the JSON parser encounters a key while reading an object.

virtual IJsonHandler *	readObjectEnd ()=0
	Called when the JSON parser encounters the end of an object.

virtual IJsonHandler *	readArrayStart ()=0
	Called when the JSON parser encounters the start of an array.

virtual IJsonHandler *	readArrayEnd ()=0
	Called when the JSON parser encounters the end of an array.

virtual void	reportWarning (const std::string &warning, std::vector< std::string > &&context=std::vector< std::string >())=0
	Report a warning while reading JSON.

Detailed Description

Base interface for all JSON handlers. Types that need to be deserialized from JSON should implement IJsonHandler or a class that derives from it. As the JSON is parsed, the corresponding read... method to the token that was parsed will be called. These methods can return themselves or a different handler to handle the value.

Definition at line 18 of file IJsonHandler.h.

Constructor & Destructor Documentation

◆ ~IJsonHandler()

virtual CesiumJsonReader::IJsonHandler::~IJsonHandler ( )

inlinevirtual

Definition at line 20 of file IJsonHandler.h.

Member Function Documentation

◆ readArrayEnd()

virtual IJsonHandler * CesiumJsonReader::IJsonHandler::readArrayEnd ( )

pure virtual

Called when the JSON parser encounters the end of an array.

Returns: A IJsonHandler that will handle the next read... call. This can be the same handler as the current one.

Implemented in CesiumJsonReader::ArrayJsonHandler< T, THandler >, CesiumJsonReader::ArrayJsonHandler< double, DoubleJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::string, StringJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::vector< T >, ArrayJsonHandler< T, THandler > >, CesiumJsonReader::ArrayJsonHandler< T, IntegerJsonHandler< T > >, CesiumJsonReader::IgnoreValueJsonHandler, CesiumJsonReader::JsonHandler, and CesiumJsonReader::JsonObjectJsonHandler.

◆ readArrayStart()

virtual IJsonHandler * CesiumJsonReader::IJsonHandler::readArrayStart ( )

pure virtual

Called when the JSON parser encounters the start of an array.

Returns: A IJsonHandler that will handle the next read... call. This can be the same handler as the current one.

Implemented in CesiumJsonReader::ArrayJsonHandler< T, THandler >, CesiumJsonReader::ArrayJsonHandler< double, DoubleJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::string, StringJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::vector< T >, ArrayJsonHandler< T, THandler > >, CesiumJsonReader::ArrayJsonHandler< T, IntegerJsonHandler< T > >, CesiumJsonReader::IgnoreValueJsonHandler, CesiumJsonReader::JsonHandler, and CesiumJsonReader::JsonObjectJsonHandler.

◆ readBool()

virtual IJsonHandler * CesiumJsonReader::IJsonHandler::readBool ( bool b )

pure virtual

Called when the JSON parser encounters a boolean value.

Parameters

b	The boolean value.

Returns: A IJsonHandler that will handle the next read... call. This can be the same handler as the current one.

Implemented in CesiumJsonReader::ArrayJsonHandler< T, THandler >, CesiumJsonReader::ArrayJsonHandler< double, DoubleJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::string, StringJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::vector< T >, ArrayJsonHandler< T, THandler > >, CesiumJsonReader::ArrayJsonHandler< T, IntegerJsonHandler< T > >, CesiumJsonReader::BoolJsonHandler, CesiumJsonReader::IgnoreValueJsonHandler, CesiumJsonReader::JsonHandler, and CesiumJsonReader::JsonObjectJsonHandler.

◆ readDouble()

virtual IJsonHandler * CesiumJsonReader::IJsonHandler::readDouble ( double d )

pure virtual

Called when the JSON parser encounters a double value.

Parameters

d	The double value.

Returns: A IJsonHandler that will handle the next read... call. This can be the same handler as the current one.

Implemented in CesiumJsonReader::ArrayJsonHandler< T, THandler >, CesiumJsonReader::ArrayJsonHandler< double, DoubleJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::string, StringJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::vector< T >, ArrayJsonHandler< T, THandler > >, CesiumJsonReader::ArrayJsonHandler< T, IntegerJsonHandler< T > >, CesiumJsonReader::DoubleJsonHandler, CesiumJsonReader::IgnoreValueJsonHandler, CesiumJsonReader::IntegerJsonHandler< T >, CesiumJsonReader::JsonHandler, and CesiumJsonReader::JsonObjectJsonHandler.

◆ readInt32()

virtual IJsonHandler * CesiumJsonReader::IJsonHandler::readInt32 ( int32_t i )

pure virtual

Called when the JSON parser encounters an int32 value.

Parameters

i	The int32 value.

Returns: A IJsonHandler that will handle the next read... call. This can be the same handler as the current one.

Implemented in CesiumJsonReader::ArrayJsonHandler< T, THandler >, CesiumJsonReader::ArrayJsonHandler< double, DoubleJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::string, StringJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::vector< T >, ArrayJsonHandler< T, THandler > >, CesiumJsonReader::ArrayJsonHandler< T, IntegerJsonHandler< T > >, CesiumJsonReader::DoubleJsonHandler, CesiumJsonReader::IgnoreValueJsonHandler, CesiumJsonReader::IntegerJsonHandler< T >, CesiumJsonReader::JsonHandler, and CesiumJsonReader::JsonObjectJsonHandler.

◆ readInt64()

virtual IJsonHandler * CesiumJsonReader::IJsonHandler::readInt64 ( int64_t i )

pure virtual

Called when the JSON parser encounters an int64 value.

Parameters

i	The int64 value.

Returns: A IJsonHandler that will handle the next read... call. This can be the same handler as the current one.

Implemented in CesiumJsonReader::ArrayJsonHandler< T, THandler >, CesiumJsonReader::ArrayJsonHandler< double, DoubleJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::string, StringJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::vector< T >, ArrayJsonHandler< T, THandler > >, CesiumJsonReader::ArrayJsonHandler< T, IntegerJsonHandler< T > >, CesiumJsonReader::DoubleJsonHandler, CesiumJsonReader::IgnoreValueJsonHandler, CesiumJsonReader::IntegerJsonHandler< T >, CesiumJsonReader::JsonHandler, and CesiumJsonReader::JsonObjectJsonHandler.

◆ readNull()

virtual IJsonHandler * CesiumJsonReader::IJsonHandler::readNull ( )

pure virtual

Called when the JSON parser encounters a null.

Returns: A IJsonHandler that will handle the next read... call. This can be the same handler as the current one.

Implemented in CesiumJsonReader::ArrayJsonHandler< T, THandler >, CesiumJsonReader::ArrayJsonHandler< double, DoubleJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::string, StringJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::vector< T >, ArrayJsonHandler< T, THandler > >, CesiumJsonReader::ArrayJsonHandler< T, IntegerJsonHandler< T > >, CesiumJsonReader::IgnoreValueJsonHandler, CesiumJsonReader::JsonHandler, and CesiumJsonReader::JsonObjectJsonHandler.

◆ readObjectEnd()

virtual IJsonHandler * CesiumJsonReader::IJsonHandler::readObjectEnd ( )

pure virtual

Called when the JSON parser encounters the end of an object.

Returns: A IJsonHandler that will handle the next read... call. This can be the same handler as the current one.

Implemented in CesiumJsonReader::ArrayJsonHandler< T, THandler >, CesiumJsonReader::IgnoreValueJsonHandler, CesiumJsonReader::JsonHandler, CesiumJsonReader::JsonObjectJsonHandler, and CesiumJsonReader::ObjectJsonHandler.

◆ readObjectKey()

virtual IJsonHandler * CesiumJsonReader::IJsonHandler::readObjectKey ( const std::string_view & str )

pure virtual

Called when the JSON parser encounters a key while reading an object.

Parameters

str The key.

Returns: A IJsonHandler that will handle the next read... call. This can be the same handler as the current one.

Implemented in CesiumJsonReader::ArrayJsonHandler< T, THandler >, CesiumJsonReader::DictionaryJsonHandler< T, THandler >, CesiumJsonReader::DictionaryJsonHandler< CesiumUtility::JsonValue, CesiumJsonReader::JsonObjectJsonHandler >, CesiumJsonReader::ExtensionsJsonHandler, CesiumJsonReader::IgnoreValueJsonHandler, CesiumJsonReader::JsonHandler, and CesiumJsonReader::JsonObjectJsonHandler.

◆ readObjectStart()

virtual IJsonHandler * CesiumJsonReader::IJsonHandler::readObjectStart ( )

pure virtual

Called when the JSON parser encounters the beginning of an object.

Returns: A IJsonHandler that will handle the next read... call. This can be the same handler as the current one.

Implemented in CesiumJsonReader::ArrayJsonHandler< T, THandler >, CesiumJsonReader::ArrayJsonHandler< double, DoubleJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::string, StringJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::vector< T >, ArrayJsonHandler< T, THandler > >, CesiumJsonReader::ArrayJsonHandler< T, IntegerJsonHandler< T > >, CesiumJsonReader::IgnoreValueJsonHandler, CesiumJsonReader::JsonHandler, CesiumJsonReader::JsonObjectJsonHandler, and CesiumJsonReader::ObjectJsonHandler.

◆ readString()

virtual IJsonHandler * CesiumJsonReader::IJsonHandler::readString ( const std::string_view & str )

pure virtual

Called when the JSON parser encounters a string value.

Parameters

str	The string value.

Returns: A IJsonHandler that will handle the next read... call. This can be the same handler as the current one.

Implemented in CesiumJsonReader::ArrayJsonHandler< T, THandler >, CesiumJsonReader::ArrayJsonHandler< double, DoubleJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::string, StringJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::vector< T >, ArrayJsonHandler< T, THandler > >, CesiumJsonReader::ArrayJsonHandler< T, IntegerJsonHandler< T > >, CesiumJsonReader::IgnoreValueJsonHandler, CesiumJsonReader::JsonHandler, CesiumJsonReader::JsonObjectJsonHandler, and CesiumJsonReader::StringJsonHandler.

◆ readUint32()

virtual IJsonHandler * CesiumJsonReader::IJsonHandler::readUint32 ( uint32_t i )

pure virtual

Called when the JSON parser encounters a uint32 value.

Parameters

i	The uint32 value.

Returns: A IJsonHandler that will handle the next read... call. This can be the same handler as the current one.

Implemented in CesiumJsonReader::ArrayJsonHandler< T, THandler >, CesiumJsonReader::ArrayJsonHandler< double, DoubleJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::string, StringJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::vector< T >, ArrayJsonHandler< T, THandler > >, CesiumJsonReader::ArrayJsonHandler< T, IntegerJsonHandler< T > >, CesiumJsonReader::DoubleJsonHandler, CesiumJsonReader::IgnoreValueJsonHandler, CesiumJsonReader::IntegerJsonHandler< T >, CesiumJsonReader::JsonHandler, and CesiumJsonReader::JsonObjectJsonHandler.

◆ readUint64()

virtual IJsonHandler * CesiumJsonReader::IJsonHandler::readUint64 ( uint64_t i )

pure virtual

Called when the JSON parser encounters a uint64 value.

Parameters

i	The uint64 value.

Returns: A IJsonHandler that will handle the next read... call. This can be the same handler as the current one.

Implemented in CesiumJsonReader::ArrayJsonHandler< T, THandler >, CesiumJsonReader::ArrayJsonHandler< double, DoubleJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::string, StringJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::vector< T >, ArrayJsonHandler< T, THandler > >, CesiumJsonReader::ArrayJsonHandler< T, IntegerJsonHandler< T > >, CesiumJsonReader::DoubleJsonHandler, CesiumJsonReader::IgnoreValueJsonHandler, CesiumJsonReader::IntegerJsonHandler< T >, CesiumJsonReader::JsonHandler, and CesiumJsonReader::JsonObjectJsonHandler.

◆ reportWarning()

virtual void CesiumJsonReader::IJsonHandler::reportWarning	(	const std::string &	warning,
		std::vector< std::string > &&	context = std::vector< std::string >() )

pure virtual

Report a warning while reading JSON.

Parameters

warning	The warning to report.
context	Context information to include with this warning to help debugging.

Implemented in CesiumJsonReader::ArrayJsonHandler< T, THandler >, CesiumJsonReader::ArrayJsonHandler< double, DoubleJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::string, StringJsonHandler >, CesiumJsonReader::ArrayJsonHandler< std::vector< T >, ArrayJsonHandler< T, THandler > >, CesiumJsonReader::ArrayJsonHandler< T, IntegerJsonHandler< T > >, CesiumJsonReader::IgnoreValueJsonHandler, CesiumJsonReader::IntegerJsonHandler< T >, CesiumJsonReader::JsonHandler, and CesiumJsonReader::ObjectJsonHandler.

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

/home/runner/work/cesium-native/cesium-native/CesiumJsonReader/include/CesiumJsonReader/IJsonHandler.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IJsonHandler()

Member Function Documentation

◆ readArrayEnd()

◆ readArrayStart()

◆ readBool()

◆ readDouble()

◆ readInt32()

◆ readInt64()

◆ readNull()

◆ readObjectEnd()

◆ readObjectKey()

◆ readObjectStart()

◆ readString()

◆ readUint32()

◆ readUint64()

◆ reportWarning()