com.atlassian.clover.reporters.html

Class HtmlRenderingSupportImpl

java.lang.Object

com.atlassian.clover.reporters.html.HtmlRenderingSupportImpl

All Implemented Interfaces:

HtmlRenderingSupport

public class HtmlRenderingSupportImpl
extends Object
implements HtmlRenderingSupport

Now that rendering of velocity macros is performed from multiple threads, methods contained in this class should be thread safe.

Constructor Summary

Constructors

Constructor and Description
HtmlRenderingSupportImpl()
HtmlRenderingSupportImpl(Format format, boolean filter)

Method Summary

Modifier and Type	Method and Description
static String	blankNonAlpha(String input) Replace all non-alhphanumeric characters by a blank "_".
String	capitalize(String s)
Map<String,Number>	collectColumnValues(List<Column> columns, HasMetrics info)
int	constrain(float input, int min, int max) Returns a value a given percentage amount between min and max.
int	contains(Set set, int key)
String	format1d(float pc)
String	format2d(double aVal)
String	format3d(double aVal)
String	formatInt(int aVal)
String	formatMultiply1d(float pc, float multiplier)
String	formatMultiply1dReverse(float pc, float multiplier, float max)
String	formatShortDate(long ts)
String	getBaseFileName(BaseClassInfo classInfo)
String	getColor(StatisticsClassInfoVisitor stats, BaseClassInfo classInfo)
String	getFileIdentifier(FullFileInfo aFile)
StringBuffer	getFileLink(boolean toplevel, BaseFileInfo fileInfo)
int	getFontSize(StatisticsClassInfoVisitor stats, BaseClassInfo classInfo, int min, int max)
float	getFraction(float num, long dem)
String	getMethodIndentiation(MethodInfo methodInfo)
String	getMethodLink(boolean toplevel, FullMethodInfo mthd)
String	getPackageRelPath(String pkgA, String pkgB)
static String	getPcWidth(float pc)
static String	getPcWidth(Float pc)
String	getPercentStr(float aPc)
String	getPkgURLPath(String aPkg)
String	getPkgURLPath(String aPkg, String aFile)
static int	getRemainder(int w, float aPc)
String	getRemainderPcWidth(float pc)
String	getRemainderPercentStr(float aPc)
String	getRootRelPath(String aPkg)
StringBuffer	getSrcFileLink(boolean toplevel, BaseClassInfo cls, long idParam)
StringBuffer	getSrcFileLink(boolean toplevel, boolean withAnchor, BaseClassInfo cls, BasePackageInfo pkgInContext)
StringBuffer	getSrcFileLink(boolean toplevel, boolean withAnchor, ClassInfo cls) Get a link to a source file for a given class, e.g.
StringBuffer	getSrcFileLink(boolean isTopLevel, boolean withAnchor, String className, String containingFileName, String packageName)
String	getSrcLineLink(boolean toplevel, FileInfo file, int line)
String	getTestClassLink(boolean topLevel, ClassInfo classInfo)
StringBuffer	getTestFileName(TestCaseInfo testInfo)
StringBuffer	getTestLink(boolean topLevel, TestCaseInfo testInfo)
static int	getWidth(int w, float aPc)
String	getWrappablePath(String aStr)
String	htmlEscapeStr(String aString)
String	htmlEscapeStr(String aString, String tabString, String spaceString)
static String	isAre(int value)
String	javaScriptEscapeStr(String input)
String	joinWithDots(String s1, String s2) Join two strings.
int	length(Object[] array)
String	linkifyStackTrace(String rootRelPath, FullProjectInfo proj, String trace) renders a stack trace by inserting hyperlinking for class/filenames where found.
String	linkifyStackTrace(String rootRelPath, StackTraceInfo trace)
void	listAddKeyAsLast(ArrayList<String> list, String key) Check if obj in an ArrayList, get last element, contatenate with a key and add to the end of the list.
String	listGetLast(ArrayList<String> list) ArrayList does not have getLast() method; and we need it in one velocity template.
void	listRemoveLast(ArrayList list) ArrayList does not have removeLast() method; and we need it in one velocity template.
BlockMetrics	metricsFor(HasMetrics info)
static String	pluralize(int value, String word)
Set<TestCaseInfo>	tcisInHitRange(Map<TestCaseInfo,BitSet> tcisAndHits, CoverageDataRange range) Helper method used because Velocity doesn't support static method invocations
String	truncateEnd(String str)
String	truncateEnd(String str, int length)
String	truncateStart(String str)

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlRenderingSupportImpl

public HtmlRenderingSupportImpl()

HtmlRenderingSupportImpl

public HtmlRenderingSupportImpl(Format format,
                                boolean filter)

Method Detail

collectColumnValues

public Map<String,Number> collectColumnValues(List<Column> columns,
                                              HasMetrics info)
                                       throws CloverException

Throws:

CloverException

metricsFor

public BlockMetrics metricsFor(HasMetrics info)

formatShortDate

public String formatShortDate(long ts)

getPercentStr

public String getPercentStr(float aPc)

getRemainderPercentStr

public String getRemainderPercentStr(float aPc)

getPkgURLPath

public String getPkgURLPath(String aPkg)

getPkgURLPath

public String getPkgURLPath(String aPkg,
                            String aFile)

getFileIdentifier

public String getFileIdentifier(FullFileInfo aFile)

getRootRelPath

public String getRootRelPath(String aPkg)

Specified by:

getRootRelPath in interface HtmlRenderingSupport

getPackageRelPath

public String getPackageRelPath(String pkgA,
                                String pkgB)

Specified by:

getPackageRelPath in interface HtmlRenderingSupport

Returns:

the path of package pkgA relative to the pkgB, ie: we are in pkgB and want to get to package A.

getWrappablePath

public String getWrappablePath(String aStr)

getTestFileName

public StringBuffer getTestFileName(TestCaseInfo testInfo)

getTestLink

public StringBuffer getTestLink(boolean topLevel,
                                TestCaseInfo testInfo)

getSrcFileLink

public StringBuffer getSrcFileLink(boolean toplevel,
                                   BaseClassInfo cls,
                                   long idParam)

getFileLink

public StringBuffer getFileLink(boolean toplevel,
                                BaseFileInfo fileInfo)

getSrcFileLink

public StringBuffer getSrcFileLink(boolean toplevel,
                                   boolean withAnchor,
                                   BaseClassInfo cls,
                                   BasePackageInfo pkgInContext)

getSrcFileLink

public StringBuffer getSrcFileLink(boolean toplevel,
                                   boolean withAnchor,
                                   ClassInfo cls)

Description copied from interface: HtmlRenderingSupport

Get a link to a source file for a given class, e.g. "com/abc/A.java#A"

Specified by:

getSrcFileLink in interface HtmlRenderingSupport

Parameters:

toplevel - whether we need a link to a file from a top level (will contain package path) or not (will have a link to file only)

withAnchor - whether link should contain an anchor to the clas

cls - class we want a link for

Returns:

StringBuffer

getMethodLink

public String getMethodLink(boolean toplevel,
                            FullMethodInfo mthd)

getSrcLineLink

public String getSrcLineLink(boolean toplevel,
                             FileInfo file,
                             int line)

getSrcFileLink

public StringBuffer getSrcFileLink(boolean isTopLevel,
                                   boolean withAnchor,
                                   String className,
                                   String containingFileName,
                                   String packageName)

getMethodIndentiation

public String getMethodIndentiation(MethodInfo methodInfo)

getBaseFileName

public String getBaseFileName(BaseClassInfo classInfo)

getWidth

public static int getWidth(int w,
                           float aPc)

getRemainder

public static int getRemainder(int w,
                               float aPc)

getPcWidth

public static String getPcWidth(float pc)

getPcWidth

public static String getPcWidth(Float pc)

getRemainderPcWidth

public String getRemainderPcWidth(float pc)

format1d

public String format1d(float pc)

formatMultiply1d

public String formatMultiply1d(float pc,
                               float multiplier)

formatMultiply1dReverse

public String formatMultiply1dReverse(float pc,
                                      float multiplier,
                                      float max)

truncateEnd

public String truncateEnd(String str)

truncateEnd

public String truncateEnd(String str,
                          int length)

truncateStart

public String truncateStart(String str)

formatInt

public String formatInt(int aVal)

format2d

public String format2d(double aVal)

format3d

public String format3d(double aVal)

capitalize

public String capitalize(String s)

joinWithDots

public String joinWithDots(String s1,
                           String s2)

Join two strings. Add a dot between them if they're not empty. Function is useful for contatenating a package name.

listAddKeyAsLast

public void listAddKeyAsLast(@NotNull
                             ArrayList<String> list,
                             @NotNull
                             String key)

Check if obj in an ArrayList, get last element, contatenate with a key and add to the end of the list.

listGetLast

@Nullable
public String listGetLast(@NotNull
                                    ArrayList<String> list)

ArrayList does not have getLast() method; and we need it in one velocity template.

listRemoveLast

public void listRemoveLast(@NotNull
                           ArrayList list)

ArrayList does not have removeLast() method; and we need it in one velocity template.

contains

public int contains(Set set,
                    int key)

length

public int length(Object[] array)

htmlEscapeStr

public String htmlEscapeStr(String aString)

htmlEscapeStr

public String htmlEscapeStr(String aString,
                            String tabString,
                            String spaceString)

Specified by:

htmlEscapeStr in interface HtmlRenderingSupport

javaScriptEscapeStr

public String javaScriptEscapeStr(String input)

linkifyStackTrace

public String linkifyStackTrace(String rootRelPath,
                                FullProjectInfo proj,
                                String trace)

renders a stack trace by inserting hyperlinking for class/filenames where found.

Returns:

stack trace with hyperlinked class links

linkifyStackTrace

public String linkifyStackTrace(String rootRelPath,
                                StackTraceInfo trace)

getTestClassLink

public String getTestClassLink(boolean topLevel,
                               ClassInfo classInfo)

constrain

public int constrain(float input,
                     int min,
                     int max)

Returns a value a given percentage amount between min and max.

Returns:

a value representing input along the interval min--max.

getFontSize

public int getFontSize(StatisticsClassInfoVisitor stats,
                       BaseClassInfo classInfo,
                       int min,
                       int max)

getColor

public String getColor(StatisticsClassInfoVisitor stats,
                       BaseClassInfo classInfo)

getFraction

public float getFraction(float num,
                         long dem)

tcisInHitRange

public Set<TestCaseInfo> tcisInHitRange(Map<TestCaseInfo,BitSet> tcisAndHits,
                                        CoverageDataRange range)

Helper method used because Velocity doesn't support static method invocations

pluralize

public static String pluralize(int value,
                               String word)

blankNonAlpha

public static String blankNonAlpha(String input)

Replace all non-alhphanumeric characters by a blank "_".

isAre

public static String isAre(int value)