public class Report
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static interface |
Report.CustomReportManager |
static class |
Report.Settings
Specify what parts of the reports to generate.
|
static interface |
Report.StartGenListener |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
INDEX_FILE_NAME |
static java.lang.String |
MARKER_FILE_NAME |
Constructor and Description |
---|
Report() |
Report(InterviewParameters params,
java.io.File dir)
Deprecated.
It is expected that you call writeReport() if you use this
constructor.
|
Report(InterviewParameters params,
java.io.File dir,
TestFilter tf)
Deprecated.
It is expected that you call writeReport() if you use this
constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addStartGenListener(Report.StartGenListener l) |
java.io.File[] |
checkExistingFiles()
Checks whether writing this report will overwrite any existing files.
|
static java.lang.String[] |
getFilenamesUsed()
Returns all filenames that may be used when creating a report
of any type (HTML, plain text, XML, etc...).
|
static java.lang.String[] |
getHtmlReportFilenames() |
static java.lang.String[] |
getPlainReportFilenames() |
java.io.File |
getReportDir()
Gets the report directory that is currently defined.
|
static Report.Settings |
getSettingsPrefs() |
static boolean |
isReportDirectory(java.io.File d)
Checks if the input directory contains JT Harness reports.
|
void |
removeStartGeneratingListener(Report.StartGenListener l) |
static void |
writePrefs(Report.Settings s) |
void |
writeReport()
Deprecated.
Use
writeReport(Settings, File)
It is expected that you use a deprecated constructor
if you use this method. |
void |
writeReport(Report.Settings s,
java.io.File dir)
Write report files using the given settings, to the given location.
|
void |
writeReport(java.lang.String type)
New entry point for batch mode (only).
|
void |
writeReports(Report.Settings s,
java.io.File dir,
java.util.Collection customReports) |
public static final java.lang.String MARKER_FILE_NAME
public static final java.lang.String INDEX_FILE_NAME
public Report()
public Report(InterviewParameters params, java.io.File dir)
params
- Configuration parameters to be included in the report.dir
- The directory to which to write the report.public Report(InterviewParameters params, java.io.File dir, TestFilter tf)
params
- Configuration parameters to be included in the report.dir
- The directory to which to write the report.tf
- The test filter to be used to filter out tests in the report.public java.io.File[] checkExistingFiles()
public void writeReport(Report.Settings s, java.io.File dir) throws java.io.IOException
java.io.IOException
public void writeReports(Report.Settings s, java.io.File dir, java.util.Collection customReports) throws java.io.IOException
java.io.IOException
public void writeReport() throws java.io.IOException
writeReport(Settings, File)
It is expected that you use a deprecated constructor
if you use this method.java.io.IOException
- if the is a problem while writing the reports.public void writeReport(java.lang.String type) throws java.io.IOException
type
- The report type identifier, may be a custom type.java.lang.IllegalArgumentException
- if the type parameter does not
identify a proper report type.java.io.IOException
public static boolean isReportDirectory(java.io.File d)
d
- The directory to be checked.public java.io.File getReportDir()
public static java.lang.String[] getHtmlReportFilenames()
public static java.lang.String[] getPlainReportFilenames()
public static java.lang.String[] getFilenamesUsed()
public static void writePrefs(Report.Settings s)
public static Report.Settings getSettingsPrefs()
public void addStartGenListener(Report.StartGenListener l)
public void removeStartGeneratingListener(Report.StartGenListener l)
Copyright (c) 1996, 2011, Oracle and/or its affiliates. All rights reserved.