Class XmlMessageReporterBase<M>

java.lang.Object

com.github.oowekyala.ooxml.messages.XmlMessageReporterBase<M>

All Implemented Interfaces:

XmlMessageReporter<M>, AutoCloseable

public abstract class XmlMessageReporterBase<M>
extends Object
implements XmlMessageReporter<M>

Base implementation of XmlMessageReporter.

Field Summary

Fields

Modifier and Type	Field	Description
protected final OoxmlFacade	ooxml
protected final XmlPositioner	positioner

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XmlMessageReporterBase(OoxmlFacade ooxml, XmlPositioner positioner)

Method Summary

Modifier and Type	Method	Description
M	at(Node node)	Returns the second stage, which typically allows reporting messages like reporter.at(node).error("an error");.
void	close()	Do nothing by default.
protected abstract M	create2ndStage(XmlPosition position, XmlPositioner positioner)	Creates the object returned by at(Node).
protected void	handleEx(XmlException e)	Handle an XML exception.

Methods inherited from class Object

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

Field Details

positioner

protected final XmlPositioner positioner

ooxml

protected final OoxmlFacade ooxml

Constructor Details

XmlMessageReporterBase

protected XmlMessageReporterBase(OoxmlFacade ooxml,
 XmlPositioner positioner)

Method Details

create2ndStage

protected abstract M create2ndStage(XmlPosition position,
 XmlPositioner positioner)

Creates the object returned by at(Node). Override this instead of at(Node) because maybe in the future other at(Node) overloads will be provided.

Parameters:

position - Position of the message

positioner - Positioner

handleEx

protected void handleEx(XmlException e)

Handle an XML exception. The default just calls the printer.

at

public M at(Node node)

Description copied from interface: XmlMessageReporter

Returns the second stage, which typically allows reporting messages like reporter.at(node).error("an error");.

Specified by:

at in interface XmlMessageReporter<M>

close

public void close()

Do nothing by default.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface XmlMessageReporter<M>