Module org.matwoess.jsourceprofiler.tool

Package org.matwoess.jsourceprofiler.tool.profile

Class ReportSourceWriter

java.lang.Object

org.matwoess.jsourceprofiler.tool.profile.AbstractHtmlWriter

org.matwoess.jsourceprofiler.tool.profile.ReportSourceWriter

public class ReportSourceWriter
extends AbstractHtmlWriter

The writer class for the annotated source code report file of a java file.

Field Summary

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

bodyScripts, cssFiles, includeScripts, title

Constructor Summary

Constructors

Constructor	Description
ReportSourceWriter(JavaFile javaFile)	Creates a new ReportSourceWriter object for the given java file.

Method Summary

Modifier and Type	Method	Description
void	body()	Generates the main content of the HTML document by calling preCodeElement().
Path	getFileOutputPath()	Returns the file output path to write the file to.

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

ReportSourceWriter

public ReportSourceWriter(JavaFile javaFile)

Creates a new ReportSourceWriter object for the given java file.

Parameters:

javaFile - the file to write the report file for

Method Details

body

public void body()

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

Specified by:

body in class AbstractHtmlWriter

getFileOutputPath

public Path getFileOutputPath()

Returns the file output path to write the file to. The path is determined by calling IO.getReportSourceFilePath(java.nio.file.Path) with the relative java file path.

Specified by:

getFileOutputPath in class AbstractHtmlWriter

Returns:

the file output path