public interface ResultsFormatter
ResultsFormatter
- Formatter of the parsing results.Modifier and Type | Method and Description |
---|---|
void |
format()
format the results from one parsed file
|
void |
formatBatch()
Format the batch run results.
|
void |
setAuthors(java.util.List authors)
setAuthors - set the values of the @author tags found |
void |
setBatchMode(BatchSummary batchSummary)
Set if the JCSC run was in batch mode or single file
and set the associated data.
|
void |
setClassName(java.lang.String name)
setClass - the name of the class |
void |
setLineCount(int count)
setLineCount - the number of Lines |
void |
setMethodMetrics(java.util.List metrics)
setMethodMetrics - set all the method metrics |
void |
setMethodsCount(int count)
setMethodsCount - the number of methods count |
void |
setNCSSCount(int count)
setNCSSCount - the number of NCSS
non commenting source statements |
void |
setOutputStream(java.io.OutputStream os)
setOutputStream - set the outputstream to write to |
void |
setPackage(java.lang.String name)
setPackage - the name of the package the class belongs to |
void |
setUnitTestClassCount(int count)
setUnitTestClassCount - the count of unit test classes |
void |
setUnitTestsCount(int count)
setUnitTestsCount - the count of unit tests |
void |
setViolations(java.util.List violations)
setViolations - set all the violations which occured |
void |
setViolationsCount(int count)
setViolationsCount - the count of violations |
void |
setViolationSorter(ViolationsSorter sorter)
Set the algorithm for how the violations shall be sorted
|
void setOutputStream(java.io.OutputStream os)
setOutputStream
- set the outputstream to write toos
- an OutputStream
valuevoid setViolations(java.util.List violations)
setViolations
- set all the violations which occuredviolations
- a Collection
of Violation
void setMethodMetrics(java.util.List metrics)
setMethodMetrics
- set all the method metricsmetrics
- a Collection
of MethodMetrics
void setPackage(java.lang.String name)
setPackage
- the name of the package the class belongs toname
- a String
valuevoid setClassName(java.lang.String name)
setClass
- the name of the classname
- a String
valuevoid setAuthors(java.util.List authors)
setAuthors
- set the values of the @author tags foundauthors
- a Collection
valuevoid setViolationsCount(int count)
setViolationsCount
- the count of violationscount
- an int
valuevoid setUnitTestClassCount(int count)
setUnitTestClassCount
- the count of unit test classescount
- an int
valuevoid setUnitTestsCount(int count)
setUnitTestsCount
- the count of unit testscount
- an int
valuevoid setNCSSCount(int count)
setNCSSCount
- the number of NCSS
non commenting source statementscount
- an int
valuevoid setLineCount(int count)
setLineCount
- the number of Linescount
- an int
valuevoid setMethodsCount(int count)
setMethodsCount
- the number of methods countcount
- an int
valuevoid setViolationSorter(ViolationsSorter sorter)
sorter
- void setBatchMode(BatchSummary batchSummary)
batchSummary
- all data from batch runvoid format()
void formatBatch()
JCSC is released under the terms of the GNU General Public License