com.atlassian.clover.spi.lang

Interface LanguageConstruct

All Known Implementing Classes:

LanguageConstruct.Builtin

public interface LanguageConstruct

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LanguageConstruct.Builtin Language constructs that Clover supports for the languages it supports out-of-the-box.

Method Summary

Modifier and Type	Method and Description
String	calcCoverageMsg(SourceInfo sourceRegion, int trueBranchCount, int falseBranchCount, Locale locale) Calculates the message to be shown for the construct given its location in source, its coverage count and the current locale
String	getId()

Method Detail

getId

String getId()

Returns:

a unique, unchanging ID for the language construct. It should be as short as possible as it is stored in the clover database for each occurance of the construct.

calcCoverageMsg

String calcCoverageMsg(SourceInfo sourceRegion,
                       int trueBranchCount,
                       int falseBranchCount,
                       Locale locale)

Calculates the message to be shown for the construct given its location in source, its coverage count and the current locale

Parameters:

sourceRegion - the region in source where the construct occurred

trueBranchCount - the coverage count for the true branch. If the construct is not a branch, the coverage is supplied here

falseBranchCount - the coverage count for the false branch or 0 if the construct doesn't support false branches

locale - the locale for the message

Returns:

String message