org.pageseeder.berlioz.util

Class ErrorCollector<T extends Throwable>

java.lang.Object

org.pageseeder.berlioz.util.ErrorCollector<T>

Type Parameters:

T - The class of exception that is collected.

Direct Known Subclasses:

SAXErrorCollector, XSLTErrorCollector

public class ErrorCollector<T extends Throwable>
extends Object

An error listener wrapping the XSLT engines default listener and recording occurring errors as XML so that they can be used.

Since:

Berlioz 0.8.1

Version:

Berlioz 0.9.32 - 29 January 2015

Author:

Christophe Lauret

Constructor Summary

Constructors

Constructor and Description
ErrorCollector() Creates a new error collector.

Method Summary

Modifier and Type	Method and Description
void	collect(CollectedError.Level level, T exception) Collect an error reported by an underlying process such as a parser or a transformer.
void	collectQuietly(CollectedError.Level level, T exception) Collect an error reported by an underlying process such as a parser or a transformer without throwing any exception.
List<CollectedError<T>>	getErrors() Returns the list of collected errors.
boolean	hasError() Indicate whether any error was recorded by this error collector.
void	setErrorFlag(CollectedError.Level threshold) Set the threshold to set to rise the error flag.
void	setException(CollectedError.Level threshold) Set the threshold to throw an exception during the next collect operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorCollector

public ErrorCollector()

Creates a new error collector.

Method Detail

setException

public final void setException(CollectedError.Level threshold)

Set the threshold to throw an exception during the next collect operation.

Parameters:

threshold - the level at which the next collect call will throw an exception.

Throws:

NullPointerException - If the threshold argument is null.

setErrorFlag

public final void setErrorFlag(CollectedError.Level threshold)

Set the threshold to set to rise the error flag.

Parameters:

threshold - the level at which the next collect call set the error flag to true.

Throws:

NullPointerException - If the threshold argument is null.

collect

public final void collect(CollectedError.Level level,
                          T exception)
                   throws T extends Throwable

Collect an error reported by an underlying process such as a parser or a transformer.

Note: this method should generally be called at the end of a function at it can throw an exception if the threshold was reached.

Parameters:

level - The level of the exception.

exception - The exception thrown by the underlying process.

Throws:

T - If the exception threshold has been reached, the exception passed as argument is thrown.

NullPointerException - If either argument is null.

T extends Throwable

collectQuietly

public final void collectQuietly(CollectedError.Level level,
                                 T exception)

Collect an error reported by an underlying process such as a parser or a transformer without throwing any exception.

Parameters:

level - The level of the exception.

exception - The exception thrown by the underlying process.

Throws:

NullPointerException - If either argument is null.

getErrors

public final List<CollectedError<T>> getErrors()

Returns the list of collected errors.

Returns:

the list of collected errors.

hasError

public final boolean hasError()

Indicate whether any error was recorded by this error collector.

Returns:

true if any error was reported; false otherwise.