Json::StringRequirement Class Reference

Requirements on strings. More...

#include <StringRequirement.h>

Inheritance diagram for Json::StringRequirement:

Public Member Functions
	StringRequirement ()
	Constructor.
virtual void	Reset () override
	Reset Requirement.
virtual void	Parse (Value json, const std::string &path) override
	Parse JSON value to generate Requirement. More...
virtual void	Validate (const Value &json, const std::string &path) override
	Validate string 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
bool	minSet_
	If True, minimum length requirement is active.
bool	maxSet_
	If True, maximum length requirement is active.
bool	rgxSet_
	If True, string has to match regular expression.
size_t	minLength_
	Minimum string length;.
size_t	maxLength_
	Maximum string length;.
std::regex	regex_
	Regular expression to match string to.
std::string	expr_
	Expression.
std::string	path_
	Path for JSON path specification.
std::vector< std::string >	enum_
	Enum values.

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 strings.

Definition at line 37 of file StringRequirement.h.

Member Function Documentation

Parse()

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

inlineoverridevirtual

Parse JSON value to generate Requirement.

Parameters

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

Implements Json::Requirement.

Definition at line 78 of file StringRequirement.h.

        {
            Reset();
            
            path_ = path;
            if(json.isMember("minLength") && json["minLength"].isUInt())
            {
                minSet_ = true;
                minLength_ = json["minLength"].asUInt();
            }
            
            if(json.isMember("maxLength") && json["maxLength"].isUInt())
            {
                maxSet_ = true;
                maxLength_ = json["maxLength"].asUInt();
            
            }
 
            if(json.isMember("pattern") && json["pattern"].isString())
            {
                rgxSet_ = true;
                expr_ = json["pattern"].asString();
                regex_ = std::regex(expr_, std::regex::ECMAScript);
            }
 
            if(json.isMember("enum") && json["enum"].isArray())
            {
                for(const auto& val : json["enum"])
                    enum_.push_back(val.asString());
            }
        }

References enum_, expr_, maxLength_, maxSet_, minLength_, minSet_, path_, regex_, Reset(), and rgxSet_.

Here is the call graph for this function:

Validate()

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

inlineoverridevirtual

Validate string value.

Parameters

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

This function tests if the JSON value is of type string and if the string meets the requirements loaded via StringRequirement::Parse(). If the validation fails, one or more errors are appended to the list of errors.

Implements Json::Requirement.

Definition at line 120 of file StringRequirement.h.

        {
            if(!json.isString())
            {
                PushError(path + ": Must be of type \"string\"");
                return;
            }
            
            if(minSet_ && json.asString().length() < minLength_)
                PushError(path + ": Length must be greater than " + std::to_string(minLength_));
            
            if(maxSet_ && json.asString().length() > maxLength_)
                PushError(path + ": Length must be less than " + std::to_string(minLength_));
 
            if(rgxSet_ && !std::regex_match(json.asString(), regex_))
                PushError(path + ": String must match regular expression \"" + expr_ + "\"");
 
            if(enum_.size() && std::find(enum_.begin(),enum_.end(), json.asString()) == enum_.end())
                PushError(path + ": String is not a valid entry");
        }

References enum_, expr_, maxLength_, maxSet_, minLength_, minSet_, Json::Requirement::PushError(), regex_, and rgxSet_.

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/StringRequirement.h