com.github.fge.jsonschema.walk

Class ResolvingSchemaWalker

java.lang.Object

com.github.fge.jsonschema.walk.SchemaWalker

com.github.fge.jsonschema.walk.ResolvingSchemaWalker

public final class ResolvingSchemaWalker
extends SchemaWalker

A schema walker performing JSON Reference resolution

Unlike SimpleSchemaWalker, this schema walker will attempt to resolve a JSON Reference when it sees one; it also performs syntax checking on new trees.

It also prevents information loss or infinite walking. The first event can happen if a JSON Reference resolves to an immediate child of the current tree (in which case all other children would be ignored), the second can happen if the reference resolves to a parent of the current tree.

Field Summary

Fields inherited from class com.github.fge.jsonschema.walk.SchemaWalker

tree

Constructor Summary

Constructors

Constructor and Description
ResolvingSchemaWalker(SchemaTree tree, Dictionary<PointerCollector> collectors, Dictionary<SyntaxChecker> checkers, LoadingConfiguration cfg) Fully customized schema walker
ResolvingSchemaWalker(SchemaTree tree, SchemaVersion version) Schema walker for a given version and with a default loading configuration
ResolvingSchemaWalker(SchemaTree tree, SchemaVersion version, LoadingConfiguration cfg) Constructor for a given schema version

Method Summary

Methods

Modifier and Type	Method and Description
<T> void	resolveTree(SchemaListener<T> listener, ProcessingReport report) Change the current tree to another tree, if any
String	toString()

Methods inherited from class com.github.fge.jsonschema.walk.SchemaWalker

walk

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ResolvingSchemaWalker

public ResolvingSchemaWalker(SchemaTree tree,
                     SchemaVersion version,
                     LoadingConfiguration cfg)

Constructor for a given schema version

Parameters:

tree - the starting schema tree

version - the schema version

cfg - the listening configuration

ResolvingSchemaWalker

public ResolvingSchemaWalker(SchemaTree tree,
                     SchemaVersion version)

Schema walker for a given version and with a default loading configuration

Parameters:

tree - the schema tree

version - the schema version

ResolvingSchemaWalker

public ResolvingSchemaWalker(SchemaTree tree,
                     Dictionary<PointerCollector> collectors,
                     Dictionary<SyntaxChecker> checkers,
                     LoadingConfiguration cfg)

Fully customized schema walker

Parameters:

tree - the schema tree

collectors - the pointer collectors dictionary

checkers - the syntax checkers dictionary

cfg - the loading configuration

Method Detail

resolveTree

public <T> void resolveTree(SchemaListener<T> listener,
                   ProcessingReport report)
                 throws ProcessingException

Description copied from class: SchemaWalker

Change the current tree to another tree, if any

Specified by:

resolveTree in class SchemaWalker

Type Parameters:

T - type of value produced by the listener

Parameters:

listener - the listener

report - the report

Throws:

ProcessingException - processing failure

See Also:

ResolvingSchemaWalker

toString

public String toString()

Specified by:

toString in class SchemaWalker