ISerializableToJsonObject Class Reference

Interface for objects that can serialize themselves into a QJsonObject, with JSON helper utilities. More...

#include <iserializabletojson.h>

Public Member Functions
virtual QJsonObject	serializeToJsonObject () const =0
	Serialize this object into a QJsonObject.

Static Protected Member Functions
static QJsonValue	uuidOrNull (const QUuid &uuid)
	Return a UUID as a JSON string, or null if uuid is null.
static QJsonValue	stringOrNull (const QString &value)
	Return a string as a JSON string, or null if value is empty.
static QJsonValue	intOrNull (const QVariant &value)
	Return a QVariant integer as a JSON integer, or null if variant is null.
static QJsonValue	doubleOrNull (const QVariant &value)
	Return a QVariant double as a JSON double, or null if variant is null.
static QJsonValue	doubleStringOrNull (const QVariant &value, int precision=6)
	Return a QVariant double formatted as a JSON string, or null if variant is null.
static QJsonValue	arrayOrNull (const QStringList &value)
	Return a string list as a JSON array, or null if list is empty.
static QVariant	intOrNull (const QJsonValue &value)
	Extract an integer QVariant from a JSON value, or invalid QVariant if null.
static QVariant	doubleOrNull (const QJsonValue &value)
	Extract a double QVariant from a JSON value, or invalid QVariant if null.
static QVariant	doubleStringOrNull (const QJsonValue &value, int precision=6)
	Parse a double from a JSON string value, or invalid QVariant if null.

Detailed Description

Interface for objects that can serialize themselves into a QJsonObject, with JSON helper utilities.

Definition at line 28 of file iserializabletojson.h.

Member Function Documentation

arrayOrNull()

static QJsonValue ISerializableToJsonObject::arrayOrNull ( const QStringList &  value )

staticprotected

Return a string list as a JSON array, or null if list is empty.

Parameters

value

String list to convert

Returns

JSON array value, or QJsonValue::Null

doubleOrNull() [1/2]

static QVariant ISerializableToJsonObject::doubleOrNull ( const QJsonValue &  value )

staticprotected

Extract a double QVariant from a JSON value, or invalid QVariant if null.

Parameters

value

JSON value to extract from

Returns

QVariant containing a double, or an invalid QVariant

doubleOrNull() [2/2]

static QJsonValue ISerializableToJsonObject::doubleOrNull ( const QVariant &  value )

staticprotected

Return a QVariant double as a JSON double, or null if variant is null.

Parameters

value

Variant containing a double

Returns

JSON double value, or QJsonValue::Null

doubleStringOrNull() [1/2]

static QVariant ISerializableToJsonObject::doubleStringOrNull ( const QJsonValue &  value, int  precision = 6  )

staticprotected

Parse a double from a JSON string value, or invalid QVariant if null.

Parameters

value	JSON value to parse
precision	Number of decimal places (default 6)

Returns

QVariant containing a double, or an invalid QVariant

doubleStringOrNull() [2/2]

static QJsonValue ISerializableToJsonObject::doubleStringOrNull ( const QVariant &  value, int  precision = 6  )

staticprotected

Return a QVariant double formatted as a JSON string, or null if variant is null.

Parameters

value	Variant containing a double
precision	Number of decimal places (default 6)

Returns

JSON string value, or QJsonValue::Null

intOrNull() [1/2]

static QVariant ISerializableToJsonObject::intOrNull ( const QJsonValue &  value )

staticprotected

Extract an integer QVariant from a JSON value, or invalid QVariant if null.

Parameters

value

JSON value to extract from

Returns

QVariant containing an integer, or an invalid QVariant

intOrNull() [2/2]

static QJsonValue ISerializableToJsonObject::intOrNull ( const QVariant &  value )

staticprotected

Return a QVariant integer as a JSON integer, or null if variant is null.

Parameters

value

Variant containing an integer

Returns

JSON integer value, or QJsonValue::Null

serializeToJsonObject()

virtual QJsonObject ISerializableToJsonObject::serializeToJsonObject ( ) const

pure virtual

Serialize this object into a QJsonObject.

Returns

JSON object representation of this object

Referenced by SerializableJsonList< T >::serializeToJsonArray().

stringOrNull()

static QJsonValue ISerializableToJsonObject::stringOrNull ( const QString &  value )

staticprotected

Return a string as a JSON string, or null if value is empty.

Parameters

value

String to convert

Returns

JSON string value, or QJsonValue::Null

uuidOrNull()

static QJsonValue ISerializableToJsonObject::uuidOrNull ( const QUuid &  uuid )

staticprotected

Return a UUID as a JSON string, or null if uuid is null.

Parameters

uuid	UUID to convert

Returns

JSON string value, or QJsonValue::Null

---

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

• include/Kanoop/serialization/iserializabletojson.h