org.acra.builder

Class ReportBuilder

java.lang.Object

org.acra.builder.ReportBuilder

public final class ReportBuilder
extends Object

Fluent API used to assemble the different options used for a crash report.

Since:

4.8.0

Constructor Summary

Constructors

Constructor and Description
ReportBuilder()

Method Summary

Modifier and Type	Method and Description
void	build(ReportExecutor reportExecutor) Assembles and sends the crash report.
ReportBuilder	customData(Map<String,String> customData) Sets additional values to be added to ReportField.CUSTOM_DATA.
ReportBuilder	customData(String key, String value) Sets an additional value to be added to ReportField.CUSTOM_DATA.
ReportBuilder	endApplication() Ends the application after sending the crash report
ReportBuilder	exception(Throwable e) Set the stack trace to be reported
Map<String,String>	getCustomData()
Throwable	getException()
String	getMessage()
Thread	getUncaughtExceptionThread()
boolean	isEndApplication()
boolean	isSendSilently()
ReportBuilder	message(String msg) Set the error message to be reported.
ReportBuilder	sendSilently() Forces the report to be sent silently, ignoring all interactions
ReportBuilder	uncaughtExceptionThread(Thread thread) Sets the Thread on which an uncaught Exception occurred.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportBuilder

public ReportBuilder()

Method Detail

message

@NonNull
public ReportBuilder message(@Nullable
                                      String msg)

Set the error message to be reported.

Parameters:

msg - the error message

Returns:

the updated ReportBuilder

getMessage

@Nullable
public String getMessage()

Returns:

the error message, or null if none is present

uncaughtExceptionThread

@NonNull
public ReportBuilder uncaughtExceptionThread(@Nullable
                                                      Thread thread)

Sets the Thread on which an uncaught Exception occurred.

Parameters:

thread - Thread on which an uncaught Exception occurred.

Returns:

the updated ReportBuilder

getUncaughtExceptionThread

@Nullable
public Thread getUncaughtExceptionThread()

Returns:

the Thread on which an uncaught Exception occurred, or null if none present

exception

@NonNull
public ReportBuilder exception(@Nullable
                                        Throwable e)

Set the stack trace to be reported

Parameters:

e - The exception that should be associated with this report

Returns:

the updated ReportBuilder

getException

@Nullable
public Throwable getException()

Returns:

the exception, or null if none present

customData

@NonNull
public ReportBuilder customData(@NonNull
                                         Map<String,String> customData)

Sets additional values to be added to ReportField.CUSTOM_DATA. Values specified here take precedence over globally specified custom data.

Parameters:

customData - a map of custom key-values to be attached to the report

Returns:

the updated ReportBuilder

customData

@NonNull
public ReportBuilder customData(@NonNull
                                         String key,
                                         String value)

Sets an additional value to be added to ReportField.CUSTOM_DATA. The value specified here takes precedence over globally specified custom data.

Parameters:

key - the key identifying the custom data

value - the value for the custom data entry

Returns:

the updated ReportBuilder

getCustomData

@NonNull
public Map<String,String> getCustomData()

Returns:

a map with all custom data

sendSilently

@NonNull
public ReportBuilder sendSilently()

Forces the report to be sent silently, ignoring all interactions

Returns:

the updated ReportBuilder

isSendSilently

public boolean isSendSilently()

Returns:

if this should send silently

endApplication

@NonNull
public ReportBuilder endApplication()

Ends the application after sending the crash report

Returns:

the updated ReportBuilder

isEndApplication

public boolean isEndApplication()

Returns:

if this should stop the application after collecting

build

public void build(@NonNull
                  ReportExecutor reportExecutor)

Assembles and sends the crash report.

Parameters:

reportExecutor - ReportExecutor to use to build the report.