Package org.forgerock.json.schema.validator

Class ErrorHandler

java.lang.Object

org.forgerock.json.schema.validator.ErrorHandler

Direct Known Subclasses:

CollectErrorsHandler, FailFastErrorHandler

public abstract class ErrorHandler
extends Object

ErrorHandler is the abstract base class for Validators.

If a Validator application needs to implementation of customized error handling, it must implement this class.

Use this handler when call the SimpleValidator.validate(Object, org.forgerock.json.JsonPointer, ErrorHandler)} method. The helpers will then report all errors.

Constructor Summary

Constructors

Constructor	Description
ErrorHandler()

Method Summary

Modifier and Type	Method	Description
abstract void	assembleException()	Deprecated.
abstract void	error(ValidationException exception)	Receive notification of an error.
boolean	hasError()	Get the final result of the validation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorHandler

public ErrorHandler()

Method Detail

error

public abstract void error(ValidationException exception)
                    throws SchemaException

Receive notification of an error.

For example, a validator would use this callback to report the violation of a validity constraint. The default behaviour is to take no action.

The validator must continue to provide normal validation after invoking this method: it should still be possible for the application to process the document through to the end. If the application cannot do so, then the parser should report a fatal error.

Filters may use this method to report other, non-JSON errors as well.

Parameters:

exception - The error information encapsulated in a validation exception.

Throws:

SchemaException - Any JSON exception, possibly wrapping another exception.

hasError

public boolean hasError()

Get the final result of the validation.

The default value is false. If the validator has called the {#handleError} method then it return true.

Returns:

true if there was an error during the validation process.

assembleException

@Deprecated
public abstract void assembleException()
                                throws ValidationException

Deprecated.

Throws an assembled exception after the validator finished the processing.

Implementation of this method MUST throw an Exception if the {#error()} method was called on this instance before.

Throws:

ValidationException - when this instance wraps an error message(s).