Json::IntegerRequirement Class Reference

Requirements on Integer values. More...

#include <IntegerRequirement.h>

Inheritance diagram for Json::IntegerRequirement:

Public Member Functions
	IntegerRequirement ()
	Constructor.
virtual void	Reset () override
	Reset requirement.
virtual void	Parse (Value json, const std::string &path) override
	Parse JSON value to set up Requirement. More...
virtual void	Validate (const Value &json, const std::string &path) override
	Validate JSON value. More...
Public Member Functions inherited from Json::Requirement
bool	HasErrors ()
	Check if errors have occured. More...
std::vector< std::string >	GetErrors ()
	Get list of error messages. More...
virtual void	ClearErrors ()
	Clear list of error messages.
virtual bool	HasNotices ()
	Check if notices have been queued. More...
std::vector< std::string >	GetNotices ()
	Get list of notices. More...
virtual void	ClearNotices ()
	Clear list of notice messages.
virtual	~Requirement ()
	Destructor.

Private Attributes
std::string	path_
	Path for JSON path specification.
int	multipleOf_
	Multiple of requirement.
int	min_
	Lower bound for range requirement.
int	max_
	Upper bound for range requirement.
bool	multSet_
	If True multiple of is a requirement.
bool	minSet_
	If True lower bound is an active requirement.
bool	maxSet_
	If True upper bound is an active requirement.
bool	exclMin_
	If True lower bound is exclusive.
bool	exclMax_
	If True upper bound is exclusive.

Additional Inherited Members
Protected Member Functions inherited from Json::Requirement
void	PushError (const std::string &error)
	Add error to list of error messages. More...
void	PushNotice (const std::string &notice)
	Add message to list of notices. More...

Detailed Description

Requirements on Integer values.

This class implements several types of integer requirements.

Definition at line 38 of file IntegerRequirement.h.

Member Function Documentation

Parse()

virtual void Json::IntegerRequirement::Parse ( Value  json, const std::string &  path  )

inlineoverridevirtual

Parse JSON value to set up Requirement.

Parameters

json	JSON input value.
path	Path for JSON path specification.

Implements Json::Requirement.

Definition at line 75 of file IntegerRequirement.h.

        {
            Reset();
            
            path_ = path;
            if(json.isMember("multipleOf") && json["multipleOf"].isInt())
            {
                multSet_ = true;
                multipleOf_ = json["multipleOf"].asInt();
            }
 
            if(json.isMember("minimum") && json["minimum"].isInt())
            {
                minSet_ = true;
                min_ = json["minimum"].asInt();
            }
 
            if(json.isMember("maximum") && json["maximum"].isInt())
            {
                maxSet_ = true;
                max_ = json["maximum"].asInt();
            }
 
            if(json.isMember("exclusiveMinimum") && json["exclusiveMinimum"].isBool())
            {
                exclMin_ = json["exclusiveMinimum"].asBool();
            }
 
            if(json.isMember("exclusiveMaximum") && json["exclusiveMaximum"].isBool())
            {
                exclMax_ = json["exclusiveMaximum"].asBool();
            }
        }

References exclMax_, exclMin_, max_, maxSet_, min_, minSet_, multipleOf_, multSet_, path_, and Reset().

Here is the call graph for this function:

Validate()

virtual void Json::IntegerRequirement::Validate ( const Value &  json, const std::string &  path  )

inlineoverridevirtual

Validate JSON value.

Parameters

json	JSON value to be validated.
path	Path for JSON path specification.

Validates that the given JSON value is of type Integer and meets the requirements generated by IntegerRequirement::Parse(). If the requirements are not met, an error is generated.

Implements Json::Requirement.

Definition at line 118 of file IntegerRequirement.h.

        {
            if(!json.isInt())
            {
                PushError(path + ": Must be of type \"integer\".");
                return;
            }
 
            if(multSet_ && (json.asInt() % multipleOf_ != 0))
                PushError(path + ": Value must be a multiple of " + std::to_string(multipleOf_));
 
            if(minSet_)
            {
                if(exclMin_ && json.asInt() <= min_)
                    PushError(path + ": Value must be greater than " + std::to_string(min_));
                else if(json.asInt() < min_)
                    PushError(path + ": Value cannot be less than " + std::to_string(min_));
            }
 
            if(maxSet_)
            {
                if(exclMax_ && json.asInt() >= max_)
                    PushError(path + ": Value must be less than " + std::to_string(max_));
                else if(json.asInt() > max_)
                    PushError(path + ": Value cannot be greater than " + std::to_string(max_));
            }
        }

References exclMax_, exclMin_, max_, maxSet_, min_, minSet_, multipleOf_, multSet_, and Json::Requirement::PushError().

Here is the call graph for this function:

---

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

• /home/michael/development/SSAGES/src/Validator/IntegerRequirement.h