org.acra.reporter

Class ErrorReporterImpl

java.lang.Object

org.acra.reporter.ErrorReporterImpl

All Implemented Interfaces:

SharedPreferences.OnSharedPreferenceChangeListener, Thread.UncaughtExceptionHandler, ErrorReporter

public class ErrorReporterImpl
extends Object
implements Thread.UncaughtExceptionHandler, SharedPreferences.OnSharedPreferenceChangeListener, ErrorReporter

The ErrorReporter is a Singleton object in charge of collecting crash context data and sending crash reports. It registers itself as the Application's Thread default Thread.UncaughtExceptionHandler.

When a crash occurs, it collects data of the crash context (device, system, stack trace...) and writes a report file in the application private directory, which may then be sent.

Constructor Summary

Constructors

Constructor and Description
ErrorReporterImpl(Application context, CoreConfiguration config, boolean enabled, boolean supportedAndroidVersion, boolean checkReportsOnApplicationStart)

Method Summary

Modifier and Type	Method and Description
void	clearCustomData() Removes all key/value pairs from your reports custom data field.
String	getCustomData(String key) Gets the current value for a key in your reports custom data field.
SenderScheduler	getReportScheduler() Access point to manual report scheduling
void	handleException(Throwable e) Send a normal report for the given exception.
void	handleException(Throwable e, boolean endApplication) Send a normal report for the given exception
void	handleSilentException(Throwable e) Send a silent report for the given exception
void	onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key)
String	putCustomData(String key, String value) Use this method to provide the ErrorReporter with data of your running application.
String	removeCustomData(String key) Removes a key/value pair from your reports custom data field.
void	setEnabled(boolean enabled) Enable or disable this ErrorReporter.
void	uncaughtException(Thread t, Throwable e)
void	unregister()

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorReporterImpl

public ErrorReporterImpl(@NonNull
                         Application context,
                         @NonNull
                         CoreConfiguration config,
                         boolean enabled,
                         boolean supportedAndroidVersion,
                         boolean checkReportsOnApplicationStart)

Parameters:

context - Context for the application in which ACRA is running.

config - AcraConfig to use when reporting and sending errors.

enabled - Whether this ErrorReporter should capture Exceptions and forward their reports.

supportedAndroidVersion - the minimal supported version

checkReportsOnApplicationStart - If reports should be checked on startup

Method Detail

putCustomData

public String putCustomData(@NonNull
                            String key,
                            @Nullable
                            String value)

Use this method to provide the ErrorReporter with data of your running application. You should call this at several key places in your code the same way as you would output important debug data in a log file. Only the latest value is kept for each key (no history of the values is sent in the report).

Specified by:

putCustomData in interface ErrorReporter

Parameters:

key - A key for your custom data.

value - The value associated to your key.

Returns:

The previous value for this key if there was one, or null.

See Also:

ErrorReporter.removeCustomData(String), ErrorReporter.getCustomData(String)

removeCustomData

@Nullable
public String removeCustomData(@NonNull
                                         String key)

Removes a key/value pair from your reports custom data field.

Specified by:

removeCustomData in interface ErrorReporter

Parameters:

key - The key of the data to be removed.

Returns:

The value for this key before removal.

See Also:

ErrorReporter.putCustomData(String, String), ErrorReporter.getCustomData(String)

clearCustomData

public void clearCustomData()

Removes all key/value pairs from your reports custom data field.

Specified by:

clearCustomData in interface ErrorReporter

getCustomData

@Nullable
public String getCustomData(@NonNull
                                      String key)

Gets the current value for a key in your reports custom data field.

Specified by:

getCustomData in interface ErrorReporter

Parameters:

key - The key of the data to be retrieved.

Returns:

The value for this key.

See Also:

ErrorReporter.putCustomData(String, String), ErrorReporter.removeCustomData(String)

uncaughtException

public void uncaughtException(@Nullable
                              Thread t,
                              @NonNull
                              Throwable e)

Specified by:

uncaughtException in interface Thread.UncaughtExceptionHandler

handleSilentException

public void handleSilentException(@Nullable
                                  Throwable e)

Send a silent report for the given exception

Specified by:

handleSilentException in interface ErrorReporter

Parameters:

e - The Throwable to be reported. If null the report will contain a new Exception("Report requested by developer").

setEnabled

public void setEnabled(boolean enabled)

Enable or disable this ErrorReporter. By default it is enabled.

Specified by:

setEnabled in interface ErrorReporter

Parameters:

enabled - Whether this ErrorReporter should capture Exceptions and forward them as crash reports.

handleException

public void handleException(@Nullable
                            Throwable e,
                            boolean endApplication)

Send a normal report for the given exception

Specified by:

handleException in interface ErrorReporter

Parameters:

e - The Throwable to be reported. If null the report will contain a new Exception("Report requested by developer").

endApplication - if you want the application to be ended after sending the report.

handleException

public void handleException(@Nullable
                            Throwable e)

Send a normal report for the given exception.

Specified by:

handleException in interface ErrorReporter

Parameters:

e - The Throwable to be reported. If null the report will contain a new Exception("Report requested by developer").

getReportScheduler

public SenderScheduler getReportScheduler()

Description copied from interface: ErrorReporter

Access point to manual report scheduling

Specified by:

getReportScheduler in interface ErrorReporter

Returns:

current SenderScheduler

onSharedPreferenceChanged

public void onSharedPreferenceChanged(@NonNull
                                      SharedPreferences sharedPreferences,
                                      @Nullable
                                      String key)

Specified by:

onSharedPreferenceChanged in interface SharedPreferences.OnSharedPreferenceChangeListener

unregister

public void unregister()