org.jcoderz.phoenix.report
Class CheckstyleReportReader

java.lang.Object
  org.jcoderz.phoenix.report.AbstractReportReader
      org.jcoderz.phoenix.report.CheckstyleReportReader

All Implemented Interfaces:

ValidationEventHandler, ReportReader

public final class CheckstyleReportReader
extends AbstractReportReader

This class is used to read the XML report from checkstyle. The checkstyle report is also transformed to the jCoderZ.org format.

Author:

Michael Griffel

Field Summary

static String

CHECKSTYLE_JAXB_CONTEXT_PATH JAXB context path.

Method Summary

protected Map	getItems() Returns the items of the input report as a Map of filename string and of the type Item (org.jcoderz.phoenix.report.jaxb.Item).
void	parse(File f) Parses the report file/directory.

Methods inherited from class org.jcoderz.phoenix.report.AbstractReportReader

getMarshaller, getUnmarshaller, handleEvent, merge, normalizeFileName, unmarshall

Methods inherited from class java.lang.Object

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

Field Detail

CHECKSTYLE_JAXB_CONTEXT_PATH

public static final String CHECKSTYLE_JAXB_CONTEXT_PATH

JAXB context path.

See Also:

Constant Field Values

Method Detail

parse

public void parse(File f)
           throws FileNotFoundException,
                  JAXBException

Parses the report file/directory.

Parameters:

f - input XML report or directory.

Throws:

FileNotFoundException - if the given file does not exists.

JAXBException - if an JAXB exception occures.

getItems

protected Map getItems()
                throws JAXBException

Description copied from class: AbstractReportReader

Returns the items of the input report as a Map of filename string and of the type Item (org.jcoderz.phoenix.report.jaxb.Item).

Specified by:

getItems in class AbstractReportReader

Returns:

the items of the input report as a List of the type Item.

Throws:

JAXBException - if an JAXB exception occures.