io.cdap.directives.validation.conformers

Interface Conformer<T>

Type Parameters:

T - The type of value this conformer checks.

All Known Implementing Classes:

JsonConformer

public interface Conformer<T>

Conformer represents a type that can check whether some object instance of type T follows a set of restrictions (a schema) enforced by this conformer. For example, a Conformer<JsonObject> can check if a specific JSON object validates against a specific JSON Schema.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Conformer.Factory<T> Factory interface for Conformers.

Method Summary

Modifier and Type	Method and Description
List<ConformanceIssue>	checkConformance(T value) Validate the given value against the loaded schema.
void	initialize() Initialize should setup this instance to check conformance against a specific set of requirements, for example it can load a specific JSON Schema into memory.

Method Detail

initialize

void initialize()
         throws IOException

Initialize should setup this instance to check conformance against a specific set of requirements, for example it can load a specific JSON Schema into memory.

Throws:

IOException

checkConformance

List<ConformanceIssue> checkConformance(T value)

Validate the given value against the loaded schema. It is up to the implementation to decide whether to return the first occurring error or all at once.

Parameters:

value - the value to validate

Returns:

the deviations/failures (if any; otherwise an empty list) that the value ran into when validating