hudson.plugins.sloccount.model.cloc

Class ClocReport

java.lang.Object

hudson.plugins.sloccount.model.cloc.ClocReport

All Implemented Interfaces:

Serializable

public class ClocReport
extends Object
implements Serializable

Cloc report parser and the parsed file.

Since:

1.20

Author:

Michal Turek

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClocReport() This constructor is required by JAXB.
ClocReport(ClocHeader header, ClocFiles files) Constructor.

Method Summary

Modifier and Type	Method and Description
ClocFiles	getFiles()
ClocHeader	getHeader()
static ClocReport	parse(File file) Parse one input file.
void	toSloccountReport(SloccountReportInterface report, boolean commentIsCode) Convert cloc report to SLOCCount report representation used in the plugin.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClocReport

public ClocReport(ClocHeader header,
                  ClocFiles files)

Constructor.

Parameters:

header - header

files - files

ClocReport

public ClocReport()

This constructor is required by JAXB.

Method Detail

getHeader

public ClocHeader getHeader()

getFiles

public ClocFiles getFiles()

parse

public static ClocReport parse(File file)
                        throws JAXBException

Parse one input file.

Parameters:

file - the file to be parsed

Returns:

the content of the parsed file in form of a report

Throws:

JAXBException - if a XML related error occurs

toSloccountReport

public void toSloccountReport(SloccountReportInterface report,
                              boolean commentIsCode)
                       throws JAXBException

Convert cloc report to SLOCCount report representation used in the plugin.

Parameters:

report - output report

commentIsCode - include comments to the measured lines

Throws:

JAXBException - if the report has unexpected structure