PipServices3.Commons.Validate.ValueComparisonRule Class Reference

Validation rule that compares value to a constant. More...

Inheritance diagram for PipServices3.Commons.Validate.ValueComparisonRule:

Public Member Functions
	ValueComparisonRule (string operation, object value)
	Creates a new validation rule and sets its values. More...
void	Validate (string path, Schema schema, object value, List< ValidationResult > results)
	Validates a given value against this rule. More...

Private Attributes
readonly string	_operation
readonly object	_value

Detailed Description

Validation rule that compares value to a constant.

var schema = new Schema().WithRule(new ValueComparisonRule("EQ", 1));

schema.Validate(1);          // Result: no errors
schema.Validate(2);          // Result: 2 is not equal to 1

Constructor & Destructor Documentation

ValueComparisonRule()

PipServices3.Commons.Validate.ValueComparisonRule.ValueComparisonRule	(	string	operation,
		object	value
	)

Creates a new validation rule and sets its values.

Parameters

operation	a comparison operation.
value	a constant value to compare to

Member Function Documentation

Validate()

void PipServices3.Commons.Validate.ValueComparisonRule.Validate	(	string	path,
		Schema	schema,
		object	value,
		List< ValidationResult >	results
	)

Validates a given value against this rule.

Parameters

path	a dot notation path to the value.
schema	a schema this rule is called from
value	a value to be validated.
results	a list with validation results to add new results.

Implements PipServices3.Commons.Validate.IValidationRule.

---

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

• src/Validate/ValueComparisonRule.cs