Module org.matwoess.jsourceprofiler.tool

Package org.matwoess.jsourceprofiler.tool.profile

Class ReportMethodIndexWriter

java.lang.Object

org.matwoess.jsourceprofiler.tool.profile.AbstractHtmlWriter

org.matwoess.jsourceprofiler.tool.profile.ReportMethodIndexWriter

public class ReportMethodIndexWriter
extends AbstractHtmlWriter

The writer class for the method index overview page of a java class. This page lists all methods of a class sorted by the number of invocations.

Field Summary

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

bodyScripts, cssFiles, includeScripts, title

Constructor Summary

Constructors

Constructor	Description
ReportMethodIndexWriter(JClass clazz, JavaFile javaFile)	Creates a new ReportMethodIndexWriter object.

Method Summary

Modifier and Type	Method	Description
void	body()	Generates the main content of the HTML document by calling sortedMethodTable().
Path	getFileOutputPath()	Returns the path to the HTML file to write to by calling IO.getReportMethodIndexPath(String) for the current class name.
void	sortedMethodTable()	Appends a table of all methods sorted by the number of 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

ReportMethodIndexWriter

public ReportMethodIndexWriter(JClass clazz,
 JavaFile javaFile)

Creates a new ReportMethodIndexWriter object.

Parameters:

clazz - the java class to write the method index for

javaFile - the java file containing the class

Method Details

body

public void body()

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

Specified by:

body in class AbstractHtmlWriter

sortedMethodTable

public void sortedMethodTable()

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

getFileOutputPath

public Path getFileOutputPath()

Returns the path to the HTML file to write to by calling IO.getReportMethodIndexPath(String) for the current class name.

Specified by:

getFileOutputPath in class AbstractHtmlWriter

Returns:

the path to the HTML file to write the method index to