Package com.networknt.schema

Interface OutputFormat<T>

Type Parameters:

T - the result type

All Known Implementing Classes:

OutputFormat.Boolean, OutputFormat.Default, OutputFormat.Flag, OutputFormat.Hierarchical, OutputFormat.List, OutputFormat.Result

public interface OutputFormat<T>

Formats the validation results.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	OutputFormat.Boolean	The Boolean output format.
static class	OutputFormat.Default	The Default output format.
static class	OutputFormat.Flag	The Flag output format.
static class	OutputFormat.Hierarchical	The Hierarchical output format.
static class	OutputFormat.List	The List output format.
static class	OutputFormat.Result	The Result output format.

Field Summary

Fields

Modifier and Type	Field	Description
static OutputFormat.Boolean	BOOLEAN	The Boolean output format.
static OutputFormat.Default	DEFAULT	The Default output format.
static OutputFormat.Flag	FLAG	The Flag output format.
static OutputFormat.Hierarchical	HIERARCHICAL	The Hierarchical output format.
static OutputFormat.List	LIST	The List output format.
static OutputFormat.Result	RESULT	The Result output format.

Method Summary

Modifier and Type	Method	Description
default void	customize(ExecutionContext executionContext, ValidationContext validationContext)	Customize the execution context before validation.
T	format(JsonSchema jsonSchema, Set<ValidationMessage> validationMessages, ExecutionContext executionContext, ValidationContext validationContext)	Formats the validation results.

Field Detail

DEFAULT

static final OutputFormat.Default DEFAULT

The Default output format.

BOOLEAN

static final OutputFormat.Boolean BOOLEAN

The Boolean output format.

FLAG

static final OutputFormat.Flag FLAG

The Flag output format.

LIST

static final OutputFormat.List LIST

The List output format.

HIERARCHICAL

static final OutputFormat.Hierarchical HIERARCHICAL

The Hierarchical output format.

RESULT

static final OutputFormat.Result RESULT

The Result output format.

This is currently not exposed to consumers.

Method Detail

customize

default void customize(ExecutionContext executionContext,
                       ValidationContext validationContext)

Customize the execution context before validation.

The validation context should only be used for reference as it is shared.

Parameters:

executionContext - the execution context

validationContext - the validation context for reference

format

T format(JsonSchema jsonSchema,
         Set<ValidationMessage> validationMessages,
         ExecutionContext executionContext,
         ValidationContext validationContext)

Formats the validation results.

Parameters:

jsonSchema - the schema

validationMessages - the validation messages

executionContext - the execution context

validationContext - the validation context

Returns:

the result