Class AccumulatingMessageHandler

java.lang.Object

com.github.oowekyala.ooxml.messages.AccumulatingMessageHandler

All Implemented Interfaces:

XmlMessageHandler, AutoCloseable

public abstract class AccumulatingMessageHandler
extends Object
implements XmlMessageHandler, AutoCloseable

Accumulates messages and does not display them until the reporter is closed.

Field Summary

Fields

Modifier and Type	Field	Description
protected final XmlMessageHandler	basePrinter
private final EnumMap<XmlSeverity, Map<String, List<XmlException>>>	entries
protected final XmlSeverity	minSeverity

Fields inherited from interface XmlMessageHandler

NOOP, SYSTEM_ERR

Constructor Summary

Constructors

Constructor	Description
AccumulatingMessageHandler(XmlMessageHandler basePrinter, XmlSeverity minSeverity)

Method Summary

Modifier and Type	Method	Description
void	accept(XmlException ex)	Handle an XML message.
void	close()
void	close(XmlSeverity minSeverityToPrintSummary, XmlSeverity minSeverityToPrintFully)	Close the reporter and print the accumulated exceptions.
protected void	dontPrint(XmlSeverity severity, Map<String, List<XmlException>> entriesByMessage)	Handle ignored messages.
protected void	printFully(XmlSeverity severity, String message, List<XmlException> entry)	Print "fully", the default prints all entries.
protected void	printSummary(XmlSeverity severity, String message, List<XmlException> entry)	Print a summary line, not every one of the entries.
protected abstract void	printSummaryLine(String kind, XmlSeverity severity, String message)

Methods inherited from class Object

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

Field Details

entries

private final EnumMap<XmlSeverity, Map<String, List<XmlException>>> entries

minSeverity

protected final XmlSeverity minSeverity

basePrinter

protected final XmlMessageHandler basePrinter

Constructor Details

AccumulatingMessageHandler

public AccumulatingMessageHandler(XmlMessageHandler basePrinter,
 XmlSeverity minSeverity)

Method Details

accept

public void accept(XmlException ex)

Description copied from interface: XmlMessageHandler

Handle an XML message. May throw, ignore, or print to an external stream.

Specified by:

accept in interface XmlMessageHandler

Parameters:

ex - Message to handle

printSummaryLine

protected abstract void printSummaryLine(String kind,
 XmlSeverity severity,
 String message)

close

public void close()

Specified by:

close in interface AutoCloseable

close

public void close(XmlSeverity minSeverityToPrintSummary,
 XmlSeverity minSeverityToPrintFully)

Close the reporter and print the accumulated exceptions. The two parameters select how entries are printed to the basePrinter, they are dispatched to the methods dontPrint(XmlSeverity, Map), printFully(XmlSeverity, String, List) and printSummary(XmlSeverity, String, List).

printFully

protected void printFully(XmlSeverity severity,
 String message,
 List<XmlException> entry)

Print "fully", the default prints all entries. This is so that previous errors are not forgotten.

Parameters:

severity - severity of the message

message - Message with which the entry was reported

entry - A nonempty list

printSummary

protected void printSummary(XmlSeverity severity,
 String message,
 List<XmlException> entry)

Print a summary line, not every one of the entries.

Parameters:

severity - severity of the message

message - Message with which the entry was reported

entry - A nonempty list

dontPrint

protected void dontPrint(XmlSeverity severity,
 Map<String, List<XmlException>> entriesByMessage)

Handle ignored messages.

Parameters:

severity - Severity

entriesByMessage - Entries for the given severity, indexed by their message