org.acra.config

Class ConfigurationBuilder

java.lang.Object

org.acra.config.BaseConfigurationBuilder<ConfigurationBuilder>

org.acra.config.ConfigurationBuilder

public final class ConfigurationBuilder
extends BaseConfigurationBuilder<ConfigurationBuilder>

Builder responsible for programmatic construction of an immutable ACRAConfiguration.

Since:

4.8.1

Constructor Summary

Constructors

Constructor and Description
ConfigurationBuilder(android.app.Application app) Constructs a ConfigurationBuilder that is prepopulated with any '@ReportCrashes' annotation declared on the Application class.

Method Summary

Modifier and Type	Method and Description
ACRAConfiguration	build() Builds the ACRAConfiguration which will be used to configure ACRA.
ConfigurationBuilder	setHttpHeaders(java.util.Map<java.lang.String,java.lang.String> headers) Set custom HTTP headers to be sent by the provided HttpSender.
ConfigurationBuilder	setReportField(ReportField field, boolean enable) Use this if you want to keep the default configuration of reportContent, but set some fields explicitly.

Methods inherited from class org.acra.config.BaseConfigurationBuilder

setAdditionalDropBoxTags, setAdditionalSharedPreferences, setAlsoReportToAndroidFramework, setApplicationLogFile, setApplicationLogFileDir, setApplicationLogFileLines, setAttachmentUriProvider, setAttachmentUris, setBuildConfigClass, setCertificatePath, setCertificateType, setConnectionTimeout, setCustomReportContent, setDeleteOldUnsentReportsOnApplicationStart, setDeleteUnapprovedReportsOnApplicationStart, setDropboxCollectionMinutes, setExcludeMatchingSettingsKeys, setExcludeMatchingSharedPreferencesKeys, setFormUri, setFormUriBasicAuthLogin, setFormUriBasicAuthPassword, setHttpMethod, setIncludeDropBoxSystemTags, setKeyStoreFactoryClass, setLogcatArguments, setLogcatFilterByPid, setMailTo, setNonBlockingReadForLogcat, setReportAsFile, setReportDialogClass, setReportingInteractionMode, setReportPrimerClass, setReportSenderFactoryClasses, setReportType, setResCertificate, setResDialogCommentPrompt, setResDialogEmailPrompt, setResDialogIcon, setResDialogNegativeButtonText, setResDialogOkToast, setResDialogPositiveButtonText, setResDialogText, setResDialogTheme, setResDialogTitle, setResNotifIcon, setResNotifText, setResNotifTickerText, setResNotifTitle, setResToastText, setRetryPolicyClass, setSendReportsInDevMode, setSharedPreferencesMode, setSharedPreferencesName, setSocketTimeout, setStopServicesOnCrash

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationBuilder

public ConfigurationBuilder(@NonNull
                            android.app.Application app)

Constructs a ConfigurationBuilder that is prepopulated with any '@ReportCrashes' annotation declared on the Application class.

Parameters:

app - Current Application, from which any annotated config will be gleaned.

Method Detail

build

@NonNull
public ACRAConfiguration build()
                                  throws ACRAConfigurationException

Builds the ACRAConfiguration which will be used to configure ACRA.

You can pass this ConfigurationBuilder to ACRA.init(Application, ConfigurationBuilder) and ACRA.init(Application, ConfigurationBuilder) will handle any Exception.

Returns:

new ACRAConfiguration containing all the properties configured on this builder.

Throws:

ACRAConfigurationException - if the required values for the configured notification mode have not been provided.

setReportField

@NonNull
public ConfigurationBuilder setReportField(@NonNull
                                                     ReportField field,
                                                     boolean enable)

Use this if you want to keep the default configuration of reportContent, but set some fields explicitly.

Parameters:

field - the field to set

enable - if this field should be reported

Returns:

this instance

setHttpHeaders

@NonNull
public ConfigurationBuilder setHttpHeaders(@NonNull
                                                     java.util.Map<java.lang.String,java.lang.String> headers)

Set custom HTTP headers to be sent by the provided HttpSender. This should be used also by third party senders.

Parameters:

headers - A map associating HTTP header names to their values.

Returns:

this instance