com.android.tools.lint

Class Reporter

java.lang.Object

com.android.tools.lint.Reporter

Direct Known Subclasses:

HtmlReporter, MultiProjectHtmlReporter, TextReporter

@Beta
public abstract class Reporter
extends java.lang.Object

A reporter is an output generator for lint warnings

NOTE: This is not a public or final API; if you rely on this be prepared to adjust your code for the next tools release.

Field Summary

Fields

Modifier and Type	Field and Description
protected LintCliClient	client
protected boolean	displayEmpty
protected java.io.File	output
static java.lang.String	STDERR
static java.lang.String	STDOUT
protected java.lang.String	title
protected java.util.Map<java.lang.String,java.lang.String>	urlMap

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Reporter(LintCliClient client, java.io.File output)

Method Summary

Modifier and Type	Method and Description
static Reporter	createHtmlReporter(LintCliClient client, java.io.File output, LintCliFlags flags) Creates a new HTML Reporter
static TextReporter	createTextReporter(LintCliClient client, LintCliFlags flags, java.io.File file, java.io.Writer writer, boolean close) Constructs a new text Reporter
static com.android.tools.lint.XmlReporter	createXmlReporter(LintCliClient client, java.io.File output, boolean intendedForBaseline) Constructs a new XmlReporter
java.io.File	getOutput() The report file, if any (reporters may write to stdout/stderr too)
java.lang.String	getTitle()
static boolean	hasAutoFix(com.android.tools.lint.detector.api.Issue issue) Returns true if the given issue has an automatic IDE fix.
boolean	isDisplayEmpty() Returns whether this report should display info if no issues were found
void	setDisplayEmpty(boolean displayEmpty) Sets whether this report should display info if no issues were found
void	setStripPrefix(java.lang.String prefix) Sets path prefix to strip from displayed file names
void	setTitle(java.lang.String title) Sets the report title
void	setUrlMap(java.util.Map<java.lang.String,java.lang.String> urlMap) Set mapping of path prefixes to corresponding URLs in the HTML report
protected java.lang.String	stripPath(java.lang.String path)
abstract void	write(com.android.tools.lint.LintStats stats, java.util.List<Warning> issues) Write the given warnings into the report
void	writeProjectList(com.android.tools.lint.LintStats stats, java.util.List<com.android.tools.lint.MultiProjectHtmlReporter.ProjectEntry> projects) Writes a project overview table

Methods inherited from class java.lang.Object

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

Field Detail

STDOUT

public static final java.lang.String STDOUT

See Also:

Constant Field Values

STDERR

public static final java.lang.String STDERR

See Also:

Constant Field Values

client

protected final LintCliClient client

output

protected final java.io.File output

title

protected java.lang.String title

urlMap

protected java.util.Map<java.lang.String,java.lang.String> urlMap

displayEmpty

protected boolean displayEmpty

Constructor Detail

Reporter

protected Reporter(@NonNull
                   LintCliClient client,
                   @NonNull
                   java.io.File output)

Method Detail

createHtmlReporter

@NonNull
public static Reporter createHtmlReporter(@NonNull
                                                   LintCliClient client,
                                                   @NonNull
                                                   java.io.File output,
                                                   @NonNull
                                                   LintCliFlags flags)
                                            throws java.io.IOException

Creates a new HTML Reporter

Parameters:

client - the associated client

output - the output file

flags - the command line flags

Throws:

java.io.IOException - if an error occurs

createTextReporter

@NonNull
public static TextReporter createTextReporter(@NonNull
                                                       LintCliClient client,
                                                       @NonNull
                                                       LintCliFlags flags,
                                                       @Nullable
                                                       java.io.File file,
                                                       @NonNull
                                                       java.io.Writer writer,
                                                       boolean close)

Constructs a new text Reporter

Parameters:

client - the client

flags - the flags

file - the file corresponding to the writer, if any

writer - the writer to write into

close - whether the writer should be closed when done

createXmlReporter

public static com.android.tools.lint.XmlReporter createXmlReporter(@NonNull
                                                                   LintCliClient client,
                                                                   @NonNull
                                                                   java.io.File output,
                                                                   boolean intendedForBaseline)
                                                            throws java.io.IOException

Constructs a new XmlReporter

Parameters:

client - the client

output - the output file

intendedForBaseline - whether this XML report is used to write a baseline file

Throws:

java.io.IOException - if an error occurs

write

public abstract void write(@NonNull
                           com.android.tools.lint.LintStats stats,
                           java.util.List<Warning> issues)
                    throws java.io.IOException

Write the given warnings into the report

Parameters:

stats - the vital statistics for the lint report

issues - the issues to be reported @throws IOException if an error occurs

Throws:

java.io.IOException

writeProjectList

public void writeProjectList(@NonNull
                             com.android.tools.lint.LintStats stats,
                             @NonNull
                             java.util.List<com.android.tools.lint.MultiProjectHtmlReporter.ProjectEntry> projects)
                      throws java.io.IOException

Writes a project overview table

Parameters:

stats - the vital statistics for the lint report

projects - the projects to write

Throws:

java.io.IOException

setTitle

public void setTitle(java.lang.String title)

Sets the report title

Parameters:

title - the title of the report

getTitle

public java.lang.String getTitle()

Returns:

the title of the report

getOutput

@Nullable
public java.io.File getOutput()

The report file, if any (reporters may write to stdout/stderr too)

setUrlMap

public void setUrlMap(@Nullable
                      java.util.Map<java.lang.String,java.lang.String> urlMap)

Set mapping of path prefixes to corresponding URLs in the HTML report

isDisplayEmpty

public boolean isDisplayEmpty()

Returns whether this report should display info if no issues were found

setDisplayEmpty

public void setDisplayEmpty(boolean displayEmpty)

Sets whether this report should display info if no issues were found

hasAutoFix

public static boolean hasAutoFix(com.android.tools.lint.detector.api.Issue issue)

Returns true if the given issue has an automatic IDE fix.

Parameters:

issue - the issue to be checked

Returns:

true if the given tool is known to have an automatic fix for the given issue

stripPath

protected java.lang.String stripPath(@NonNull
                                     java.lang.String path)

setStripPrefix

public void setStripPrefix(@Nullable
                           java.lang.String prefix)

Sets path prefix to strip from displayed file names