CloverReportConfig (OpenClover 4.5.2 API)

java.lang.Object
- com.atlassian.clover.reporters.CloverReportConfig

Direct Known Subclasses:: Current, Historical

public abstract class CloverReportConfig
extends Object

Constructor Summary

Constructors
Constructor and Description

CloverReportConfig()

Constructors
Constructor and Description
`CloverReportConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected HasMetricsFilter.Invertable`	`effectiveTestFilter()`
`String`	`getCharset()`
`Columns`	`getColumns()`
`CloverDatabase`	`getCoverageDatabase()`
`Date`	`getEffectiveDate()`
`CloverReportConfig`	`getFirstCurrentConfig()`
`Format`	`getFormat()`
`String`	`getHomepage()` Gets the homepage to use in the main frameset
`String`	`getInitString()`
`Map<String,CloverReportConfig>`	`getLinkedReports()`
`String`	`getMainFileName()` This method returns the name of the main file used in this report.
`File`	`getMainOutFile()` Gets the main out file for this report.
`File`	`getOutFile()`
`long`	`getReportDelay()`
`Path`	`getSourcepath()`
`Interval`	`getSpan()`
`HasMetricsFilter.Invertable`	`getTestFilter()`
`String`	`getTitle()`
`String`	`getTitleAnchor()`
`int`	`getTitleCount()`
`String`	`getTitleTarget()`
`String`	`getUniqueTitle()`
`String`	`getValidationFailureReason()`
`int`	`incTitleCount()`
`boolean`	`isAlwaysReport()`
`boolean`	`isColumnsSet()`
`boolean`	`isCompress()`
`boolean`	`isLoadPerTestData()`
`boolean`	`isLoadTestResults()`
`boolean`	`isNeedsNewFrame()`
`boolean`	`isSkipCoverageTreeMap()`
`void`	`setAlwaysReport(boolean alwaysReport)`
`void`	`setCharset(String encoding)`
`void`	`setColumns(Columns columns)`
`void`	`setCompress(boolean compress)`
`void`	`setCoverageCacheSize(StorageSize size)`
`void`	`setEffectiveDate(Date effectiveDate)`
`protected void`	`setFailureReason(String reason)`
`void`	`setFirstCurrentConfig(CloverReportConfig currentRoot)`
`void`	`setFormat(Format format)`
`void`	`setHomepage(String homepage)` Sets the homepage to be used
`void`	`setIncludeFilter(HasMetricsFilter includeFilter)`
`void`	`setInitString(String initString)`
`void`	`setLinkedReports(Map<String,CloverReportConfig> links)` Sets the linked reports map.
`void`	`setLoadPerTestData(boolean loadPerTestData)`
`void`	`setLoadTestResults(boolean loadTestResults)`
`void`	`setMainFileName(String mainFileName)` The mainFileName is used by HTML reports when rendering links to other reports.
`void`	`setNeedsNewFrame(boolean needsNewFrame)`
`void`	`setOutFile(File outFile)`
`void`	`setProjectName(String projectName)` Sets the project name to use in the reports
`void`	`setReportDelay(long delay)`
`void`	`setSkipCoverageTreeMap(boolean skipCoverageTreeMap)`
`void`	`setSourcepath(Path sourcepath)`
`void`	`setSpan(Interval span)`
`void`	`setTestFilter(HasMetricsFilter.Invertable testFilter)`
`void`	`setTitle(String title)` Set the report title
`void`	`setTitleAnchor(String titleAnchor)`
`void`	`setTitleTarget(String titleTarget)`
`void`	`setUniqueTitle(String uniqueTitle)`
`boolean`	`validate()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- CloverReportConfig
```
public CloverReportConfig()
```

Method Detail

setFirstCurrentConfig

public void setFirstCurrentConfig(CloverReportConfig currentRoot)

getFirstCurrentConfig
```
public CloverReportConfig getFirstCurrentConfig()
```
Returns:

the Config to the first current report if this is a linked report. null if not linked or no current reports in the list

getHomepage
```
public String getHomepage()
```
Gets the homepage to use in the main frameset

Returns:

the homepage to use

setHomepage
```
public void setHomepage(String homepage)
```
Sets the homepage to be used

Parameters:

homepage - the homepage to use

setProjectName
```
public void setProjectName(String projectName)
```
Sets the project name to use in the reports

Parameters:

projectName - the name of the project

setLinkedReports

public void setLinkedReports(Map<String,CloverReportConfig> links)

Sets the linked reports map.

getLinkedReports

public Map<String,CloverReportConfig> getLinkedReports()

getUniqueTitle
```
public String getUniqueTitle()
```

setUniqueTitle

public void setUniqueTitle(String uniqueTitle)

getTitleCount
```
public int getTitleCount()
```

incTitleCount
```
public int incTitleCount()
```

setInitString

public void setInitString(String initString)

getInitString
```
public String getInitString()
```

setOutFile
```
public void setOutFile(File outFile)
```

getOutFile
```
public File getOutFile()
```

getMainFileName
```
public String getMainFileName()
```
This method returns the name of the main file used in this report. e.g. index.html in a Current HTML report.

Returns:

the name of the main out file of this report

getMainOutFile
```
public File getMainOutFile()
```
Gets the main out file for this report. If outFile is a file, it will be returned, otherwise, the main file will be calculated using outFile and mainFileName.

Returns:

the main file used to reference this report by

isNeedsNewFrame
```
public boolean isNeedsNewFrame()
```

setNeedsNewFrame

public void setNeedsNewFrame(boolean needsNewFrame)

setMainFileName
```
public void setMainFileName(String mainFileName)
```
The mainFileName is used by HTML reports when rendering links to other reports. This name should be the file part of the full name, as returned by calling File.getName().

setAlwaysReport

public void setAlwaysReport(boolean alwaysReport)

isAlwaysReport
```
public boolean isAlwaysReport()
```

isCompress
```
public boolean isCompress()
```

setCompress

public void setCompress(boolean compress)

setSourcepath

public void setSourcepath(Path sourcepath)

getSourcepath
```
public Path getSourcepath()
```

setTitle
```
public void setTitle(String title)
```
Set the report title

Parameters:

title - the report's title.

getTitleAnchor
```
public String getTitleAnchor()
```

setTitleAnchor

public void setTitleAnchor(String titleAnchor)

getTitleTarget
```
public String getTitleTarget()
```

setTitleTarget

public void setTitleTarget(String titleTarget)

setSpan
```
public void setSpan(Interval span)
```

getSpan
```
public Interval getSpan()
```

setEffectiveDate

public void setEffectiveDate(Date effectiveDate)

getEffectiveDate
```
public Date getEffectiveDate()
```

setCharset

public void setCharset(String encoding)

getCharset
```
public String getCharset()
```

getTitle
```
public String getTitle()
```

setFormat
```
public void setFormat(Format format)
```

getFormat
```
public Format getFormat()
```

isColumnsSet
```
public boolean isColumnsSet()
```

getColumns
```
public Columns getColumns()
```

setColumns

public void setColumns(Columns columns)

isLoadTestResults
```
public boolean isLoadTestResults()
```

setLoadTestResults

public void setLoadTestResults(boolean loadTestResults)

validate
```
public boolean validate()
```

getValidationFailureReason

public String getValidationFailureReason()

setFailureReason

protected void setFailureReason(String reason)

getCoverageDatabase

public CloverDatabase getCoverageDatabase()
                                   throws CloverException

Throws:: CloverException

effectiveTestFilter

protected HasMetricsFilter.Invertable effectiveTestFilter()

setIncludeFilter

public void setIncludeFilter(HasMetricsFilter includeFilter)

setTestFilter

public void setTestFilter(HasMetricsFilter.Invertable testFilter)

getTestFilter

public HasMetricsFilter.Invertable getTestFilter()

isLoadPerTestData
```
public boolean isLoadPerTestData()
```

setLoadPerTestData

public void setLoadPerTestData(boolean loadPerTestData)

setCoverageCacheSize

public void setCoverageCacheSize(StorageSize size)

getReportDelay
```
public long getReportDelay()
```

setReportDelay

public void setReportDelay(long delay)

isSkipCoverageTreeMap

public boolean isSkipCoverageTreeMap()

setSkipCoverageTreeMap

public void setSkipCoverageTreeMap(boolean skipCoverageTreeMap)

Class CloverReportConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CloverReportConfig

Method Detail

setFirstCurrentConfig

getFirstCurrentConfig

getHomepage

setHomepage

setProjectName

setLinkedReports

getLinkedReports

getUniqueTitle

setUniqueTitle

getTitleCount

incTitleCount

setInitString

getInitString

setOutFile

getOutFile

getMainFileName

getMainOutFile

isNeedsNewFrame

setNeedsNewFrame

setMainFileName

setAlwaysReport

isAlwaysReport

isCompress

setCompress

setSourcepath

getSourcepath

setTitle

getTitleAnchor

setTitleAnchor

getTitleTarget

setTitleTarget

setSpan

getSpan

setEffectiveDate

getEffectiveDate

setCharset

getCharset

getTitle

setFormat

getFormat

isColumnsSet

getColumns

setColumns

isLoadTestResults

setLoadTestResults

validate

getValidationFailureReason

setFailureReason

getCoverageDatabase

effectiveTestFilter

setIncludeFilter

setTestFilter

getTestFilter

isLoadPerTestData

setLoadPerTestData

setCoverageCacheSize

getReportDelay

setReportDelay

isSkipCoverageTreeMap

setSkipCoverageTreeMap