Package org.eclipse.mat.report
Interface Params
public interface Params
Available parameters for use in the report XML files.
- No Implement:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceParameters specific to HTML reports.static interfaceControl the rendering of a report. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringIf given, the filename is used to create the output file.static final StringIf given, used to create a zip file name by adding the suffix to the prefix.static final StringThe format parameter determines the renderer to be used.static final StringNot usedstatic final StringNot usedstatic final StringSet to the time the report is generated.
-
Field Details
-
TIMESTAMP
Set to the time the report is generated.- See Also:
-
SNAPSHOT
Not used- See Also:
-
SNAPSHOT_PREFIX
Not used- See Also:
-
FORMAT
The format parameter determines the renderer to be used. By default, the "html" format is used, but one could use "csv" to create a comma separated file or "txt" to create a text file. MatchesRenderer.target()of anIOutputter.- See Also:
-
FILENAME
If given, the filename is used to create the output file. Depending on the output format, this could be HTML or CSV. The property can be configured for every Spec. If the output format is HTML, the Spec must also specifyParams.Html.SEPARATE_FILE. For the HTML outputter this is not inherited from outer Specs.- See Also:
-
FILENAME_SUFFIX
If given, used to create a zip file name by adding the suffix to the prefix. Allows the suffix to be separately specified in XML report definition from the report title, so it is possible to translate the title but not the suffix if required.- Since:
- 1.0
- See Also:
-