com.github.fge.jsonschema.walk

Interface SchemaListener<T>

Type Parameters:

T - the value type produced by this listener

public interface SchemaListener<T>

A schema walker listener

This is the main working part of a walking process. A SchemaWalker will invoke a listener at various points in time when it walks the schema.

All methods can throw a ProcessingException if you choose to abort processing due to an anomalous condition.

Method Summary

Methods

Modifier and Type	Method and Description
T	getValue() Return the value produced by this listener
void	onExit() Method called when the walking process is done walking the tree
void	onInit(SchemaTree tree) Method called before schema walking commences
void	onNewTree(SchemaTree oldTree, SchemaTree newTree) Method called when the walking process changes trees
void	onPopd() Method called when the walking process exits a subtree
void	onPushd(JsonPointer pointer) Method called when the walker changes pointer into the current tree
void	onWalk(SchemaTree tree) Method called when the current tree node is walked

Method Detail

onInit

void onInit(SchemaTree tree)
            throws ProcessingException

Method called before schema walking commences

Parameters:

tree - the walked schema tree

Throws:

ProcessingException - processing failure

onNewTree

void onNewTree(SchemaTree oldTree,
             SchemaTree newTree)
               throws ProcessingException

Method called when the walking process changes trees

Parameters:

oldTree - the old tree

newTree - the new tree

Throws:

ProcessingException - processing failure

See Also:

ResolvingSchemaWalker

onPushd

void onPushd(JsonPointer pointer)
             throws ProcessingException

Method called when the walker changes pointer into the current tree

Parameters:

pointer - the relative pointer into the tree

Throws:

ProcessingException - processing failure

onWalk

void onWalk(SchemaTree tree)
            throws ProcessingException

Method called when the current tree node is walked

Parameters:

tree - the current tree

Throws:

ProcessingException - processing failure

onPopd

void onPopd()
            throws ProcessingException

Method called when the walking process exits a subtree

Throws:

ProcessingException - processing failure

onExit

void onExit()
            throws ProcessingException

Method called when the walking process is done walking the tree

Throws:

ProcessingException - processing failure

getValue

T getValue()

Return the value produced by this listener

Returns:

the value