cat.ereza.customactivityoncrash

Class CustomActivityOnCrash

java.lang.Object

cat.ereza.customactivityoncrash.CustomActivityOnCrash

public final class CustomActivityOnCrash
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CustomActivityOnCrash()

Method Summary

Methods

Modifier and Type	Method and Description
static void	closeApplication(android.app.Activity activity) Closes the app.
static java.lang.String	getAllErrorDetailsFromIntent(android.content.Context context, android.content.Intent intent) Given an Intent, returns several error details including the stack trace extra from the intent.
static int	getDefaultErrorActivityDrawable() Returns the default error activity drawable identifier.
static int	getDefaultErrorActivityDrawableIdFromIntent(android.content.Intent intent) Given an Intent, returns the drawable id of the image to show on the default error activity.
static java.lang.Class<? extends android.app.Activity>	getErrorActivityClass() Returns the error activity class to launch when a crash occurs.
static java.lang.Class<? extends android.app.Activity>	getRestartActivityClass() Returns the main activity class that the error activity must launch when a crash occurs.
static java.lang.Class<? extends android.app.Activity>	getRestartActivityClassFromIntent(android.content.Intent intent) Given an Intent, returns the restart activity class extra from it.
static java.lang.String	getStackTraceFromIntent(android.content.Intent intent) Given an Intent, returns the stack trace extra from it.
static void	install(android.content.Context context) Installs CustomActivityOnCrash on the application using the default error activity.
static boolean	isEnableAppRestart() Returns if the error activity should show a restart button.
static boolean	isLaunchErrorActivityWhenInBackground() Returns if the error activity must be launched when the app is on background.
static boolean	isShowErrorDetails() Returns if the error activity will show the error details button.
static boolean	isShowErrorDetailsFromIntent(android.content.Intent intent) Given an Intent, returns if the error details button should be displayed.
static void	restartApplicationWithIntent(android.app.Activity activity, android.content.Intent intent) Given an Intent, restarts the app and launches a startActivity to that intent.
static void	setDefaultErrorActivityDrawable(int defaultErrorActivityDrawableId) Defines which drawable to use in the default error activity image.
static void	setEnableAppRestart(boolean enableAppRestart) Defines if the error activity should show a restart button.
static void	setErrorActivityClass(java.lang.Class<? extends android.app.Activity> errorActivityClass) Sets the error activity class to launch when a crash occurs.
static void	setLaunchErrorActivityWhenInBackground(boolean launchErrorActivityWhenInBackground) Defines if the error activity must be launched when the app is on background.
static void	setRestartActivityClass(java.lang.Class<? extends android.app.Activity> restartActivityClass) Sets the main activity class that the error activity must launch when a crash occurs.
static void	setShowErrorDetails(boolean showErrorDetails) Defines if the error activity must shown the error details button.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomActivityOnCrash

public CustomActivityOnCrash()

Method Detail

install

public static void install(android.content.Context context)

Installs CustomActivityOnCrash on the application using the default error activity.

Parameters:

context - Context to use for obtaining the ApplicationContext. Must not be null.

isShowErrorDetailsFromIntent

public static boolean isShowErrorDetailsFromIntent(android.content.Intent intent)

Given an Intent, returns if the error details button should be displayed.

Parameters:

intent - The Intent. Must not be null.

Returns:

true if the button must be shown, false otherwise.

getDefaultErrorActivityDrawableIdFromIntent

public static int getDefaultErrorActivityDrawableIdFromIntent(android.content.Intent intent)

Given an Intent, returns the drawable id of the image to show on the default error activity.

Parameters:

intent - The Intent. Must not be null.

Returns:

The id of the drawable to use.

getStackTraceFromIntent

public static java.lang.String getStackTraceFromIntent(android.content.Intent intent)

Given an Intent, returns the stack trace extra from it.

Parameters:

intent - The Intent. Must not be null.

Returns:

The stacktrace, or null if not provided.

getAllErrorDetailsFromIntent

public static java.lang.String getAllErrorDetailsFromIntent(android.content.Context context,
                                            android.content.Intent intent)

Given an Intent, returns several error details including the stack trace extra from the intent.

Parameters:

context - A valid context. Must not be null.

intent - The Intent. Must not be null.

Returns:

The full error details.

getRestartActivityClassFromIntent

public static java.lang.Class<? extends android.app.Activity> getRestartActivityClassFromIntent(android.content.Intent intent)

Given an Intent, returns the restart activity class extra from it.

Parameters:

intent - The Intent. Must not be null.

Returns:

The restart activity class, or null if not provided.

restartApplicationWithIntent

public static void restartApplicationWithIntent(android.app.Activity activity,
                                android.content.Intent intent)

Given an Intent, restarts the app and launches a startActivity to that intent. The flags NEW_TASK and CLEAR_TASK are set if the Intent does not have them, to ensure the app stack is fully cleared. Must only be used from your error activity.

Parameters:

activity - The current error activity. Must not be null.

intent - The Intent. Must not be null.

closeApplication

public static void closeApplication(android.app.Activity activity)

Closes the app. Must only be used from your error activity.

Parameters:

activity - The current error activity. Must not be null.

isLaunchErrorActivityWhenInBackground

public static boolean isLaunchErrorActivityWhenInBackground()

Returns if the error activity must be launched when the app is on background.

Returns:

true if it will be launched, false otherwise.

setLaunchErrorActivityWhenInBackground

public static void setLaunchErrorActivityWhenInBackground(boolean launchErrorActivityWhenInBackground)

Defines if the error activity must be launched when the app is on background. Set it to true if you want to launch the error activity when the app is in background, false if you want it not to launch and crash silently. This has no effect in API<14 and the error activity is always launched. The default is true (the app will be brought to front when a crash occurs).

isShowErrorDetails

public static boolean isShowErrorDetails()

Returns if the error activity will show the error details button.

Returns:

true if it will be shown, false otherwise.

setShowErrorDetails

public static void setShowErrorDetails(boolean showErrorDetails)

Defines if the error activity must shown the error details button. Set it to true if you want to show the full stack trace and device info, false if you want it to be hidden. The default is true.

getDefaultErrorActivityDrawable

public static int getDefaultErrorActivityDrawable()

Returns the default error activity drawable identifier.

Returns:

the default error activity drawable identifier

setDefaultErrorActivityDrawable

public static void setDefaultErrorActivityDrawable(int defaultErrorActivityDrawableId)

Defines which drawable to use in the default error activity image. Set this if you want to use an image other than the default one. The default is R.drawable.customactivityoncrash_error_image (a cute upside-down bug).

isEnableAppRestart

public static boolean isEnableAppRestart()

Returns if the error activity should show a restart button. Note that even if restart is enabled, a valid restart activity could not be found. In that case, a close button will still be used.

Returns:

true if a restart button should be shown, false if a close button must be used.

setEnableAppRestart

public static void setEnableAppRestart(boolean enableAppRestart)

Defines if the error activity should show a restart button. Set it to true if you want to show a restart button, false if you want to show a close button. Note that even if restart is enabled, a valid restart activity could not be found. In that case, a close button will still be used. The default is true.

getErrorActivityClass

public static java.lang.Class<? extends android.app.Activity> getErrorActivityClass()

Returns the error activity class to launch when a crash occurs.

Returns:

The class, or null if not set.

setErrorActivityClass

public static void setErrorActivityClass(java.lang.Class<? extends android.app.Activity> errorActivityClass)

Sets the error activity class to launch when a crash occurs. If null,the default error activity will be used.

getRestartActivityClass

public static java.lang.Class<? extends android.app.Activity> getRestartActivityClass()

Returns the main activity class that the error activity must launch when a crash occurs.

Returns:

The class, or null if not set.

setRestartActivityClass

public static void setRestartActivityClass(java.lang.Class<? extends android.app.Activity> restartActivityClass)

Sets the main activity class that the error activity must launch when a crash occurs. If not set or set to null, the default error activity will close instead.