An abstract field validator interface for validating field values. More...
#include <cafFieldValidator.h>
Inheritance diagram for caffa::FieldValidatorInterface:
Public Types | |
| enum class | FailureSeverity { VALIDATOR_WARNING , VALIDATOR_ERROR , VALIDATOR_CRITICAL } |
| The severity of failure. Essentially tells the application how to treat a validator failure: VALIDATOR_WARNING -> user warning VALIDATOR_ERROR -> user error VALIDATOR_CRITICAL -> critical application failure. | |
Public Member Functions | |
| FieldValidatorInterface (FailureSeverity failureSeverity) | |
| Construct a new Field Validator Interface object. More... | |
| virtual void | readFromJson (const nlohmann::json &jsonFieldObject, const Serializer &serializer)=0 |
| Read the validator from JSON. More... | |
| virtual void | writeToJson (nlohmann::json &jsonFieldObject, const Serializer &serializer) const =0 |
| Write the validator to JSON. More... | |
| FailureSeverity | failureSeverity () const |
| Get the severity of a failure of the validator. More... | |
Detailed Description
An abstract field validator interface for validating field values.
Constructor & Destructor Documentation
◆ FieldValidatorInterface()
|
inline |
Construct a new Field Validator Interface object.
- Parameters
-
failureSeverity the severity of a validation failure
Member Function Documentation
◆ failureSeverity()
|
inline |
Get the severity of a failure of the validator.
- Returns
- FailureSeverity
◆ readFromJson()
|
pure virtual |
Read the validator from JSON.
- Parameters
-
jsonFieldObject the JSON value to read from serializer the serializer object
Implemented in caffa::RangeValidator< DataType >.
◆ writeToJson()
|
pure virtual |
Write the validator to JSON.
- Parameters
-
jsonFieldObject to JSON value to write to. serializer the serializer object
Implemented in caffa::RangeValidator< DataType >.
The documentation for this class was generated from the following file:
- /home/glindkvist/Projects/aru-server-app/frameworks/caffa/Core/cafFieldValidator.h
