org.acra.collector

Class CrashReportDataFactory

java.lang.Object

org.acra.collector.CrashReportDataFactory

public final class CrashReportDataFactory
extends java.lang.Object

Responsible for creating the CrashReportData for an Exception.

Also responsible for holding the custom data to send with each report.

Since:

4.3.0

Constructor Summary

Constructors

Constructor and Description
CrashReportDataFactory(android.content.Context context, ACRAConfiguration config, android.content.SharedPreferences prefs, java.util.Calendar appStartDate, Element initialConfiguration)

Method Summary

Modifier and Type	Method and Description
void	clearCustomData() Removes all key/value pairs from the custom data field.
CrashReportData	createCrashData(ReportBuilder builder) Collects crash data.
java.lang.String	getCustomData(java.lang.String key) Gets the current value for a key in the custom data field.
java.lang.String	putCustomData(java.lang.String key, java.lang.String value) Adds a custom key and value to be reported with the generated CashReportData.
java.lang.String	removeCustomData(java.lang.String key) Removes a key/value pair from the custom data field.

Methods inherited from class java.lang.Object

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

Constructor Detail

CrashReportDataFactory

public CrashReportDataFactory(@NonNull
                              android.content.Context context,
                              @NonNull
                              ACRAConfiguration config,
                              @NonNull
                              android.content.SharedPreferences prefs,
                              @NonNull
                              java.util.Calendar appStartDate,
                              @NonNull
                              Element initialConfiguration)

Method Detail

putCustomData

public java.lang.String putCustomData(@NonNull
                                      java.lang.String key,
                                      java.lang.String value)

Adds a custom key and value to be reported with the generated CashReportData.

The key/value pairs will be stored in the "custom" column, as a text containing one 'key = value' pair on each line.

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.

removeCustomData

public java.lang.String removeCustomData(@NonNull
                                         java.lang.String key)

Removes a key/value pair from the custom data field.

Parameters:

key - The key of the data to be removed.

Returns:

The value for this key before removal.

clearCustomData

public void clearCustomData()

Removes all key/value pairs from the custom data field.

getCustomData

public java.lang.String getCustomData(@NonNull
                                      java.lang.String key)

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

Parameters:

key - The key of the data to be retrieved.

Returns:

The value for this key.

createCrashData

@NonNull
public CrashReportData createCrashData(@NonNull
                                                 ReportBuilder builder)

Collects crash data.

Parameters:

builder - ReportBuilder for whom to crete the crash report.

Returns:

CrashReportData identifying the current crash.