org.pageseeder.berlioz.util

Class CollectedError<T extends Throwable>

java.lang.Object

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

Type Parameters:

T - The type of error collected.

All Implemented Interfaces:

org.pageseeder.xmlwriter.XMLWritable

public final class CollectedError<T extends Throwable>
extends Object
implements org.pageseeder.xmlwriter.XMLWritable

A simple class to associate an error collected by a parser to a level or seriousness.

This class is designed to be used with an ErrorHandler or an ErrorListener so that errors can be collected in a simple list.

Since:

Berlioz 0.8.1

Version:

Berlioz 0.9.32 - 29 January 2015

Author:

Christophe Lauret

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CollectedError.Level The level of collected error.

Constructor Summary

Constructors

Constructor and Description
CollectedError(CollectedError.Level level, T error) Creates a new collected error.

Method Summary

Modifier and Type	Method and Description
T	error() The captured error.
CollectedError.Level	level() The seriousness of the error.
void	toXML(org.pageseeder.xmlwriter.XMLWriter xml) Returns the source locator as XML.

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectedError

public CollectedError(CollectedError.Level level,
                      T error)

Creates a new collected error.

Parameters:

level - The seriousness of the error.

error - The error itself.

Throws:

NullPointerException - If either argument is null.

Method Detail

level

public CollectedError.Level level()

The seriousness of the error.

Returns:

The captured error.

error

public T error()

The captured error.

Returns:

The captured error.

toXML

public void toXML(org.pageseeder.xmlwriter.XMLWriter xml)
           throws IOException

Returns the source locator as XML.

Does nothing if the locator is null.

Specified by:

toXML in interface org.pageseeder.xmlwriter.XMLWritable

Parameters:

xml - the XML writer.

Throws:

IOException - If thrown by the XML writer.