com.android.tools.lint

Class TextReporter

java.lang.Object

com.android.tools.lint.Reporter

com.android.tools.lint.TextReporter

@Beta
public class TextReporter
extends Reporter

A reporter which emits lint warnings as plain text strings

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 inherited from class com.android.tools.lint.Reporter

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

Constructor Summary

Constructors

Constructor and Description
TextReporter(LintCliClient client, LintCliFlags flags, java.io.File file, java.io.Writer writer, boolean close) Constructs a new TextReporter
TextReporter(LintCliClient client, LintCliFlags flags, java.io.Writer writer, boolean close) Constructs a new TextReporter

Method Summary

Modifier and Type	Method and Description
boolean	isForwardSlashPaths() Gets whether the reporter should convert paths to forward slashes
void	setForwardSlashPaths(boolean forwardSlashPaths) Sets whether the reporter should convert paths to forward slashes
void	setWriteStats(boolean writeStats) Whether the report should include stats.
void	write(com.android.tools.lint.LintStats stats, java.util.List<Warning> issues) Write the given warnings into the report

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TextReporter

public TextReporter(@NonNull
                    LintCliClient client,
                    @NonNull
                    LintCliFlags flags,
                    @NonNull
                    java.io.Writer writer,
                    boolean close)

Constructs a new TextReporter

Parameters:

client - the client

flags - the flags

writer - the writer to write into

close - whether the writer should be closed when done

TextReporter

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

Constructs a new TextReporter

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

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

isForwardSlashPaths

public boolean isForwardSlashPaths()

Gets whether the reporter should convert paths to forward slashes

Returns:

true if forcing paths to forward slashes

setForwardSlashPaths

public void setForwardSlashPaths(boolean forwardSlashPaths)

Sets whether the reporter should convert paths to forward slashes

Parameters:

forwardSlashPaths - true to force paths to forward slashes

setWriteStats

public void setWriteStats(boolean writeStats)

Whether the report should include stats. Default is true.