BeJsonUtilities.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once
#include <Bentley/Bentley.h>
#include <Bentley/DateTime.h>
#include <Bentley/WString.h>
#include <Bentley/NonCopyableClass.h>
#include <json/json.h>

BEGIN_BENTLEY_NAMESPACE

typedef Json::Value& JsonValueR;
typedef Json::Value const& JsonValueCR;

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct BeJsonUtilities
{
public:
    static bool HasRequiredMembers(JsonValueCR valueObj, Utf8CP const* requiredMembers);

    static bool HasOnlyExpectedMembers(JsonValueCR valueObj, Utf8CP const* requiredMembers, Utf8CP const* optionalMembers);

    static Json::Value StringValueFromInt64(int64_t lld);

    static uint64_t UInt64FromValue(JsonValueCR value, uint64_t defaultOnError = 0);

    static int64_t Int64FromValue(JsonValueCR value, int64_t defaultOnError = 0);

    static DateTime DateTimeFromValue(JsonValueCR value);

    static bool IsValidObject(Utf8CP objectName, JsonValueCR objectValue, Utf8CP const* requiredMembers, Utf8CP const* optionalMembers);

    static Utf8CP CStringFromStringValue(JsonValueCR stringValue, Utf8CP defaultCString);
};

END_BENTLEY_NAMESPACE