Class AbstractXmlEventParser

java.lang.Object

org.eluder.coveralls.maven.plugin.parser.AbstractXmlEventParser

All Implemented Interfaces:

CoverageParser

Direct Known Subclasses:

CloverParser, CoberturaParser, JaCoCoParser, SagaParser

public abstract class AbstractXmlEventParser
extends Object
implements CoverageParser

The Class AbstractXmlEventParser.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractXmlEventParser(File coverageFile, SourceLoader sourceLoader)	Instantiates a new abstract xml event parser.

Method Summary

Modifier and Type	Method	Description
protected XMLStreamReader	createEventReader(InputStream inputStream)	Creates the event reader.
final File	getCoverageFile()	Gets the coverage file.
protected final boolean	isEndElement(XMLStreamReader xml, String name)	Checks if is end element.
protected final boolean	isStartElement(XMLStreamReader xml, String name)	Checks if is start element.
protected final Source	loadSource(String sourceFile)	Load source.
protected abstract void	onEvent(XMLStreamReader xml, SourceCallback callback)	On event.
final void	parse(SourceCallback callback)	Parses a coverage report.

Methods inherited from class Object

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

Constructor Details

AbstractXmlEventParser

protected AbstractXmlEventParser(File coverageFile,
 SourceLoader sourceLoader)

Instantiates a new abstract xml event parser.

Parameters:

coverageFile - the coverage file

sourceLoader - the source loader

Method Details

parse

public final void parse(SourceCallback callback)
                 throws ProcessingException,
IOException

Description copied from interface: CoverageParser

Parses a coverage report. Parsed source files are passed to the callback handler. This method should be called only once per instance.

Specified by:

parse in interface CoverageParser

Parameters:

callback - the source callback handler

Throws:

ProcessingException - if processing of the coverage report fails

IOException - if an I/O error occurs

getCoverageFile

public final File getCoverageFile()

Description copied from interface: CoverageParser

Gets the coverage file.

Specified by:

getCoverageFile in interface CoverageParser

Returns:

the coverage report file under processing

createEventReader

protected XMLStreamReader createEventReader(InputStream inputStream)
                                     throws ProcessingException

Creates the event reader.

Parameters:

inputStream - the input stream

Returns:

the XML stream reader

Throws:

ProcessingException - the processing exception

onEvent

protected abstract void onEvent(XMLStreamReader xml,
 SourceCallback callback)
                         throws XMLStreamException,
ProcessingException,
IOException

On event.

Parameters:

xml - the xml

callback - the callback

Throws:

XMLStreamException - the XML stream exception

ProcessingException - the processing exception

IOException - Signals that an I/O exception has occurred.

loadSource

protected final Source loadSource(String sourceFile)
                           throws IOException

Load source.

Parameters:

sourceFile - the source file

Returns:

the source

Throws:

IOException - Signals that an I/O exception has occurred.

isStartElement

protected final boolean isStartElement(XMLStreamReader xml,
 String name)

Checks if is start element.

Parameters:

xml - the xml

name - the name

Returns:

true, if is start element

isEndElement

protected final boolean isEndElement(XMLStreamReader xml,
 String name)

Checks if is end element.

Parameters:

xml - the xml

name - the name

Returns:

true, if is end element