org.acra.builder

Class ReportBuilder

java.lang.Object

org.acra.builder.ReportBuilder

public final class ReportBuilder
extends java.lang.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(java.util.Map<java.lang.String,java.lang.String> customData) Sets additional values to be added to CUSTOM_DATA.
ReportBuilder	customData(java.lang.String key, java.lang.String value) Sets an additional value to be added to CUSTOM_DATA.
ReportBuilder	endApplication() Ends the application after sending the crash report
ReportBuilder	exception(java.lang.Throwable e) Set the stack trace to be reported
java.util.Map<java.lang.String,java.lang.String>	getCustomData()
java.lang.Throwable	getException()
java.lang.String	getMessage()
java.lang.Thread	getUncaughtExceptionThread()
boolean	isEndApplication()
boolean	isSendSilently()
ReportBuilder	message(java.lang.String msg) Set the error message to be reported.
ReportBuilder	sendSilently() Forces the report to be sent silently, ignoring the default interaction mode set in the config
ReportBuilder	uncaughtExceptionThread(java.lang.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
                                       java.lang.String msg)

Set the error message to be reported.

Parameters:

msg - the error message

Returns:

the updated ReportBuilder

getMessage

@Nullable
public java.lang.String getMessage()

uncaughtExceptionThread

@NonNull
public ReportBuilder uncaughtExceptionThread(@Nullable
                                                       java.lang.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 java.lang.Thread getUncaughtExceptionThread()

exception

@NonNull
public ReportBuilder exception(@Nullable
                                         java.lang.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 java.lang.Throwable getException()

customData

@NonNull
public ReportBuilder customData(@NonNull
                                          java.util.Map<java.lang.String,java.lang.String> customData)

Sets additional values to be added to 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
                                          java.lang.String key,
                                          java.lang.String value)

Sets an additional value to be added to 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 java.util.Map<java.lang.String,java.lang.String> getCustomData()

sendSilently

@NonNull
public ReportBuilder sendSilently()

Forces the report to be sent silently, ignoring the default interaction mode set in the config

Returns:

the updated ReportBuilder

isSendSilently

public boolean isSendSilently()

endApplication

@NonNull
public ReportBuilder endApplication()

Ends the application after sending the crash report

Returns:

the updated ReportBuilder

isEndApplication

public boolean isEndApplication()

build

public void build(@NonNull
                  ReportExecutor reportExecutor)

Assembles and sends the crash report.

Parameters:

reportExecutor - ReportExecutor to use to build the report.