ZFSerializableUtil.h File Reference

utilities for ZFSerializable's implementation More...

#include "ZFSerializable.h"
#include "ZFOutputDefault.h"

Go to the source code of this file.

Namespaces
namespace	ZFSerializableUtil

Macros
#define	ZFSerializableUtilErrorOccurredAt(outErrorHint, outErrorPos, errorPos, fmt, ...)
	util method to set error
#define	ZFSerializableUtilErrorOccurred(outErrorHint, fmt, ...)
	util method to set error
#define	ZFSerializableUtilSerializeAttrFromData(serializableData, outErrorHint, outErrorPos, check_or_require, key, TypeName, value, failAction)
	util macro to impl ZFSerializable
#define	ZFSerializableUtilSerializeAttrToData(serializableData, outErrorHint, ref, key, TypeName, thisValue, refData, defaultValue, failAction)
	util macro to impl ZFSerializable
#define	ZFSerializableUtilSerializeAttrToDataNoRef(serializableData, outErrorHint, key, TypeName, thisValue, defaultValue, failAction)
	util macro to impl ZFSerializable
#define	ZFSerializableUtilSerializeCategoryFromData(serializableData, outErrorHint, outErrorPos, check_or_require, key, TypeName, value, failAction)
	util macro to impl ZFSerializable
#define	ZFSerializableUtilSerializeCategoryToData(serializableData, outErrorHint, ref, key, TypeName, thisValue, refData, defaultValue, failAction)
	util macro to impl ZFSerializable
#define	ZFSerializableUtilSerializeCategoryToDataNoRef(serializableData, outErrorHint, key, TypeName, thisValue, defaultValue, failAction)
	util macro to impl ZFSerializable

Functions
zfstring	ZFSerializableUtil::checkItemClass (const ZFSerializableData &serializableData, const zfstring &desiredClass)
	util to check whether the serializable data contains desired attribute
zfstring	ZFSerializableUtil::requireItemClass (const ZFSerializableData &serializableData, const zfstring &desiredClass, zfstring *outErrorHint=zft_zfnull, ZFSerializableData *outErrorPos=zft_zfnull)
	see checkItemClass, output error hint if failed
zfstring	ZFSerializableUtil::checkAttr (const ZFSerializableData &serializableData, const zfstring &desiredAttr)
	util to check whether the serializable data contains desired attribute, auto mark as resolved
zfstring	ZFSerializableUtil::requireAttr (const ZFSerializableData &serializableData, const zfstring &desiredAttr, zfstring *outErrorHint=zft_zfnull, ZFSerializableData *outErrorPos=zft_zfnull)
	see checkAttr, output error hint if failed, auto mark as resolved
ZFSerializableData	ZFSerializableUtil::checkElementByName (const ZFSerializableData &serializableData, const zfstring &desiredElementName)
	util to check whether the serializable data contains desired element, auto mark name as resolved
ZFSerializableData	ZFSerializableUtil::requireElementByName (const ZFSerializableData &serializableData, const zfstring &desiredElementName, zfstring *outErrorHint=zft_zfnull, ZFSerializableData *outErrorPos=zft_zfnull)
	see checkElementByName, output error hint if failed, auto mark name as resolved
ZFSerializableData	ZFSerializableUtil::checkElementByCategory (const ZFSerializableData &serializableData, const zfstring &desiredElementCategory)
	util to check whether the serializable data contains desired element, auto mark category as resolved
ZFSerializableData	ZFSerializableUtil::requireElementByCategory (const ZFSerializableData &serializableData, const zfstring &desiredElementCategory, zfstring *outErrorHint=zft_zfnull, ZFSerializableData *outErrorPos=zft_zfnull)
	see checkElementByCategory, output error hint if failed, auto mark category as resolved
zfstring	ZFSerializableUtil::checkPropertyName (const ZFSerializableData &serializableData)
	util to check whether the serializable data contains property name attribute, auto mark as resolved
zfstring	ZFSerializableUtil::requirePropertyName (const ZFSerializableData &serializableData, zfstring *outErrorHint=zft_zfnull, ZFSerializableData *outErrorPos=zft_zfnull)
	see checkPropertyName, output error hint if failed, auto mark as resolved
zfstring	ZFSerializableUtil::checkPropertyValue (const ZFSerializableData &serializableData)
	util to check whether the serializable data contains property value attribute, auto mark as resolved
zfstring	ZFSerializableUtil::requirePropertyValue (const ZFSerializableData &serializableData, zfstring *outErrorHint=zft_zfnull, ZFSerializableData *outErrorPos=zft_zfnull)
	see checkPropertyValue, output error hint if failed, auto mark as resolved
zfstring	ZFSerializableUtil::checkCategory (const ZFSerializableData &serializableData)
	util to check whether the serializable data contains category, auto mark as resolved
zfstring	ZFSerializableUtil::requireCategory (const ZFSerializableData &serializableData, zfstring *outErrorHint=zft_zfnull, ZFSerializableData *outErrorPos=zft_zfnull)
	see checkCategory, output error hint if failed, auto mark as resolved
zfbool	ZFSerializableUtil::printResolveStatus (const ZFSerializableData &serializableData, const ZFOutput &outputCallback=ZFOutputDefault())
	util method to print resolve status of ZFSerializableData, for debug use only, output nothing if all resolved

Detailed Description

utilities for ZFSerializable's implementation