at.favre.lib.planb

Class PlanB

java.lang.Object

at.favre.lib.planb.PlanB

public final class PlanB
extends java.lang.Object

PlanB is a local crash reporting and recovery library.

This is the main API of the library.

Note: if the app crashes with an unhandled exception, all classes will lose their state. So any code executed after handling he exception will be called with a new Application object.

Method Summary

Modifier and Type	Method and Description
static RecoverBehaviorFactory	behaviourFactory()
static CrashDataHandlerFactory	crashDataHandlerFactory()
void	disableCrashHandler() Disables the defined crash handler and sets the default one.
void	enableCrashHandler(android.content.Context context, CrashRecoverBehaviour behaviour) Enables the crash handling logic, setting the config and behaviour.
void	enableCrashHandler(android.content.Context context, CrashRecoverBehaviour debugCrashBehaviour, CrashRecoverBehaviour releaseCrashBehaviour) Enables the crash handling logic, setting the config and behaviour.
static PlanB	get() Gets an instance of the singleton
PlanBConfig	getConfig() PlanB must be init(Context) before this can be called
CrashDataHandler	getCrashDataHandler() Get the current crash data handler implementation.
void	init(boolean debugBuild, PlanBConfig config) Init the library.
void	init(android.content.Context context) Init the library.
void	init(android.content.Context context, boolean debugBuild) Init the library.
boolean	isDebugBuild() Returns the value passed or (or gathered) during init(Context, boolean)
static PlanBConfig.Builder	newConfig(android.content.Context context) Creates a new config builder

Methods inherited from class java.lang.Object

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

Method Detail

behaviourFactory

public static RecoverBehaviorFactory behaviourFactory()

Returns:

factory for creating crash recover behaviour

crashDataHandlerFactory

public static CrashDataHandlerFactory crashDataHandlerFactory()

Returns:

factory for creating crash handler (which persist crashes)

newConfig

public static PlanBConfig.Builder newConfig(android.content.Context context)

Creates a new config builder

Parameters:

context -

Returns:

builder

get

public static PlanB get()

Gets an instance of the singleton

init

public void init(android.content.Context context)

Init the library. This is required before any other feature can be used. Will create a default CrashDataHandler. Internally checks the manifest if this is an debuggable build.

Parameters:

context -

init

public void init(android.content.Context context,
                 boolean debugBuild)

Init the library. This is required before any other feature can be used. Will create a default CrashDataHandler.

Parameters:

context -

debugBuild - if this is a debug or release build; usually BuildConfig.DEBUG is the correct boolean to pass here

init

public void init(boolean debugBuild,
                 PlanBConfig config)

Init the library. This is required before any other feature can be used. Will create a default CrashDataHandler.

Parameters:

debugBuild - if this is a debug or release build; usually BuildConfig.DEBUG is the correct boolean to pass here

config - configure versions and build info aswell as crash handler

enableCrashHandler

public void enableCrashHandler(android.content.Context context,
                               CrashRecoverBehaviour behaviour)

Enables the crash handling logic, setting the config and behaviour.

This method will set itself as Thread.getDefaultUncaughtExceptionHandler() so be aware if you have other crash reporting frameworks like HokeyApp, Crashlytics or ACRA.

This call requires that init(Context, boolean) was called first.

Parameters:

behaviour - what exactly to do when a crash occurs

context - see newConfig(Context)

enableCrashHandler

public void enableCrashHandler(android.content.Context context,
                               CrashRecoverBehaviour debugCrashBehaviour,
                               CrashRecoverBehaviour releaseCrashBehaviour)

Enables the crash handling logic, setting the config and behaviour.

This method will set itself as Thread.getDefaultUncaughtExceptionHandler() so be aware if you have other crash reporting frameworks like HokeyApp, Crashlytics or ACRA.

This call requires that init(Context, boolean) was called first.

Parameters:

debugCrashBehaviour - behaviour for debug builds

releaseCrashBehaviour - behaviour for release builds

context - see newConfig(Context)

disableCrashHandler

public void disableCrashHandler()

Disables the defined crash handler and sets the default one.

isDebugBuild

public boolean isDebugBuild()

Returns the value passed or (or gathered) during init(Context, boolean)

Returns:

true if this is a debuggable build

getCrashDataHandler

public CrashDataHandler getCrashDataHandler()

Get the current crash data handler implementation. Only works after initialization.

getConfig

public PlanBConfig getConfig()

PlanB must be init(Context) before this can be called

Returns:

currently set config