FormatKeyword Class

Namespace: Json.Schema.Keywords.Draft06

Inheritance: FormatKeyword 🡒 FormatKeyword 🡒 object

Implemented interfaces:

• IKeywordHandler

Handles format.

Remarks

This keyword is used to validate the format of a value. Typically, this value is a string, but may be of any JSON type.

Properties

Name	Type	Summary
Annotate	FormatKeyword	Gets an instance that just annotates.
Name	string	Gets the name of the handled keyword.
Validate	FormatKeyword	Gets an instance that validates.

Methods

BuildSubschemas(KeywordData keyword, BuildContext context)

Builds and registers subschemas based on the specified keyword data within the provided build context.

Declaration

public override void BuildSubschemas(KeywordData keyword, BuildContext context)

Parameter	Type	Description
keyword	KeywordData	The keyword data used to determine which subschemas to build. Cannot be null.
context	BuildContext	The context in which subschemas are constructed and registered. Cannot be null.

Evaluate(KeywordData keyword, EvaluationContext context)

Evaluates the specified keyword using the provided evaluation context and returns the result of the evaluation.

Declaration

public override KeywordEvaluation Evaluate(KeywordData keyword, EvaluationContext context)

Parameter	Type	Description
keyword	KeywordData	The keyword data to be evaluated. Cannot be null.
context	EvaluationContext	The context in which the keyword evaluation is performed. Cannot be null.

Returns

A KeywordEvaluation object containing the results of the evaluation.

ValidateKeywordValue(JsonElement value)

Validates the specified JSON element as a keyword value and optionally returns a value to be shared across the other methods.

Declaration

public override object ValidateKeywordValue(JsonElement value)

Parameter	Type	Description
value	JsonElement	The JSON element to validate and convert. Represents the value to be checked for keyword compliance.

Returns

An object that is shared with the other methods. This object is saved to Json.Schema.KeywordData.Value.