com.android.builder.core

Class ErrorReporter

java.lang.Object

com.android.builder.core.ErrorReporter

All Implemented Interfaces:

SyncIssueHandler, com.android.ide.common.blame.MessageReceiver

public abstract class ErrorReporter
extends java.lang.Object
implements SyncIssueHandler, com.android.ide.common.blame.MessageReceiver

An error reporter for project evaluation and execution. The behavior of the reporter must vary depending on the evaluation mode (ErrorReporter.EvaluationMode), indicating whether the IDE is querying the project or not.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ErrorReporter.EvaluationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ErrorReporter(ErrorReporter.EvaluationMode mode)

Method Summary

Modifier and Type	Method and Description
ErrorReporter.EvaluationMode	getMode()
com.android.builder.model.SyncIssue	handleSyncError(java.lang.String data, int type, java.lang.String msg) Reports an error.
com.android.builder.model.SyncIssue	handleSyncWarning(java.lang.String data, int type, java.lang.String msg) Reports a warning.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.android.builder.core.SyncIssueHandler

handleIssue, hasSyncIssue

Methods inherited from interface com.android.ide.common.blame.MessageReceiver

receiveMessage

Constructor Detail

ErrorReporter

protected ErrorReporter(@NonNull
                        ErrorReporter.EvaluationMode mode)

Method Detail

getMode

@NonNull
public ErrorReporter.EvaluationMode getMode()

handleSyncError

@NonNull
public final com.android.builder.model.SyncIssue handleSyncError(@Nullable
                                                                          java.lang.String data,
                                                                          int type,
                                                                          @NonNull
                                                                          java.lang.String msg)

Reports an error.

The behavior of this method depends on whether the project is being evaluated by an IDE or from the command line. If it's the former, the error will simply be recorder and displayed after the sync properly finishes. If it's the latter, then the evaluation is aborted right away.

Parameters:

data - a data representing the source of the error. This goes hand in hand with the type, and is not meant to be readable. Instead a (possibly translated) message is created from this data and type.

type - the type of the error.

msg - a human readable error (for command line output, or if an older IDE doesn't know this particular issue type.)

Returns:

a SyncIssue if the error is only recorded.

See Also:

SyncIssue

handleSyncWarning

@NonNull
public final com.android.builder.model.SyncIssue handleSyncWarning(@Nullable
                                                                            java.lang.String data,
                                                                            int type,
                                                                            @NonNull
                                                                            java.lang.String msg)

Reports a warning.

Behaves similar to handleSyncError(String, int, String) but does not abort the build.

See Also:

handleSyncError(String, int, String)