com.github.fge.jsonschema.walk

Class SchemaWalker

java.lang.Object

com.github.fge.jsonschema.walk.SchemaWalker

Direct Known Subclasses:

ResolvingSchemaWalker, SimpleSchemaWalker

public abstract class SchemaWalker
extends Object

Main schema walker class

This class walks a JSON Schema (in the shape of a SchemaTree recursively. In order to visit subschemas, it relies on a series of PointerCollector instances (provided by a dictionary) to get the knowledge of what schemas to visit next.

Only subschemas are visited: unknown keywords, or keywords not having any subschemas, are ignored.

Important: the initial schema must be syntactically valid.

See Also:

SimpleSchemaWalker, ResolvingSchemaWalker

Field Summary

Fields

Modifier and Type	Field and Description
protected SchemaTree	tree The current schema tree being walked

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SchemaWalker(SchemaTree tree, SchemaWalkingConfiguration cfg)

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Field Detail

tree

protected SchemaTree tree

The current schema tree being walked

Constructor Detail

SchemaWalker

protected SchemaWalker(SchemaTree tree,
            SchemaWalkingConfiguration cfg)

Method Detail

walk

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

Walk a tree with a listener

Type Parameters:

T - the value type produced by the listener

Parameters:

listener - the listener

report - the processing report to use

Throws:

ProcessingException - processing failure

resolveTree

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

Change the current tree to another tree, if any

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 abstract String toString()

Overrides:

toString in class Object