com.android.tools.lint

Class HtmlReporter

java.lang.Object

com.android.tools.lint.Reporter

com.android.tools.lint.HtmlReporter

@Beta
public class HtmlReporter
extends Reporter

A reporter which emits lint results into an HTML report.

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 LintCliFlags	flags
protected java.io.Writer	writer

Fields inherited from class com.android.tools.lint.Reporter

client, displayEmpty, output, STDERR, STDOUT, title, urlMap

Constructor Summary

Constructors

Constructor and Description
HtmlReporter(LintCliClient client, java.io.File output, LintCliFlags flags) Creates a new HtmlReporter

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<com.android.tools.lint.detector.api.Issue,java.lang.String>	computeMissingIssues(java.util.List<Warning> warnings)
void	write(com.android.tools.lint.LintStats stats, java.util.List<Warning> issues) Write the given warnings into the report
void	writeCard(java.lang.Runnable appender, java.lang.String title, boolean dismissible, java.lang.String cardId, com.android.tools.lint.HtmlReporter.Action... actions)
void	writeCard(java.lang.Runnable appender, java.lang.String title, java.lang.String cardId)
void	writeCardAction(com.android.tools.lint.HtmlReporter.Action... actions)
void	writeCardFooter()
void	writeCardHeader(java.lang.String title, java.lang.String cardId)
void	writeChip(java.lang.String text)
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 com.android.tools.lint.Reporter

createHtmlReporter, createTextReporter, createXmlReporter, getOutput, getTitle, hasAutoFix, isDisplayEmpty, setDisplayEmpty, setStripPrefix, setTitle, setUrlMap, stripPath

Methods inherited from class java.lang.Object

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

Field Detail

writer

protected final java.io.Writer writer

flags

protected final LintCliFlags flags

Constructor Detail

HtmlReporter

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

Creates a new HtmlReporter

Parameters:

client - the associated client

output - the output file

flags - the command line flags

Throws:

java.io.IOException - if an error occurs

Method Detail

write

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

Description copied from class: Reporter

Write the given warnings into the report

Specified by:

write in class Reporter

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

computeMissingIssues

protected java.util.Map<com.android.tools.lint.detector.api.Issue,java.lang.String> computeMissingIssues(java.util.List<Warning> warnings)

writeCardHeader

public void writeCardHeader(@Nullable
                            java.lang.String title,
                            @NonNull
                            java.lang.String cardId)

writeCardAction

public void writeCardAction(@NonNull
                            com.android.tools.lint.HtmlReporter.Action... actions)

writeCardFooter

public void writeCardFooter()

writeCard

public void writeCard(@NonNull
                      java.lang.Runnable appender,
                      @Nullable
                      java.lang.String title,
                      @Nullable
                      java.lang.String cardId)

writeChip

public void writeChip(@NonNull
                      java.lang.String text)

writeCard

public void writeCard(@NonNull
                      java.lang.Runnable appender,
                      @Nullable
                      java.lang.String title,
                      boolean dismissible,
                      java.lang.String cardId,
                      com.android.tools.lint.HtmlReporter.Action... actions)

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

Description copied from class: Reporter

Writes a project overview table

Overrides:

writeProjectList in class Reporter

Parameters:

stats - the vital statistics for the lint report

projects - the projects to write

Throws:

java.io.IOException