Module org.matwoess.jsourceprofiler.tool

Package org.matwoess.jsourceprofiler.tool.profile

Class ReportClassIndexWriter

java.lang.Object

org.matwoess.jsourceprofiler.tool.profile.AbstractHtmlWriter

org.matwoess.jsourceprofiler.tool.profile.ReportClassIndexWriter

public class ReportClassIndexWriter
extends AbstractHtmlWriter

The writer class for the class index overview page. This is the main page of the report.

Field Summary

Fields inherited from class org.matwoess.jsourceprofiler.tool.profile.AbstractHtmlWriter

bodyScripts, cssFiles, includeScripts, title

Constructor Summary

Constructors

Constructor	Description
ReportClassIndexWriter(JavaFile[] allJavaFiles)	Creates a new ReportClassIndexWriter object.

Method Summary

Modifier and Type	Method	Description
void	body()	Generates the main content of the HTML document by calling sortedClassTable().
Path	getFileOutputPath()	Defines the output path for the generated HTML document as IO.getReportIndexPath().
void	sortedClassTable()	Appends a table of all classes sorted by the number of method invocations to the internal content.

Methods inherited from class org.matwoess.jsourceprofiler.tool.profile.AbstractHtmlWriter

bodyEnd, bodyStart, generate, header, heading, write

Methods inherited from class java.lang.Object

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

Constructor Details

ReportClassIndexWriter

public ReportClassIndexWriter(JavaFile[] allJavaFiles)

Creates a new ReportClassIndexWriter object.

Parameters:

allJavaFiles - the list of all java files contained in the project

Method Details

body

public void body()

Generates the main content of the HTML document by calling sortedClassTable().

Specified by:

body in class AbstractHtmlWriter

sortedClassTable

public void sortedClassTable()

Appends a table of all classes sorted by the number of method invocations to the internal content.

getFileOutputPath

public Path getFileOutputPath()

Defines the output path for the generated HTML document as IO.getReportIndexPath().

Specified by:

getFileOutputPath in class AbstractHtmlWriter

Returns:

the destination path of the output file