eu.chainfire.libsuperuser

Class Debug

java.lang.Object

eu.chainfire.libsuperuser.Debug

public class Debug
extends java.lang.Object

Utility class for logging and debug features that (by default) does nothing when not in debug mode

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Debug.OnLogListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOG_ALL
static int	LOG_COMMAND
static int	LOG_GENERAL
static int	LOG_NONE
static int	LOG_OUTPUT
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
Debug()

Method Summary

Modifier and Type	Method and Description
static boolean	getDebug() Is debug mode enabled ?
static boolean	getLogTypeEnabled(int type) Is logging for specific types of messages enabled ?
static boolean	getLogTypeEnabledEffective(int type) Is logging for specific types of messages enabled ?
static Debug.OnLogListener	getOnLogListener() Get the currently registered custom log handler
static boolean	getSanityChecksEnabled() Are sanity checks enabled ?
static boolean	getSanityChecksEnabledEffective() Are sanity checks enabled ?
static void	log(java.lang.String message) Log a "general" message
static void	logCommand(java.lang.String message) Log a "per-command" message
static void	logOutput(java.lang.String message) Log a line of stdout/stderr output
static boolean	onMainThread() Are we running on the main thread ?
static void	setDebug(boolean enable) Enable or disable debug mode
static void	setLogTypeEnabled(int type, boolean enable) Enable or disable logging specific types of message
static void	setOnLogListener(Debug.OnLogListener onLogListener) Register a custom log handler
static void	setSanityChecksEnabled(boolean enable) Enable or disable sanity checks

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

LOG_GENERAL

public static final int LOG_GENERAL

See Also:

Constant Field Values

LOG_COMMAND

public static final int LOG_COMMAND

See Also:

Constant Field Values

LOG_OUTPUT

public static final int LOG_OUTPUT

See Also:

Constant Field Values

LOG_NONE

public static final int LOG_NONE

See Also:

Constant Field Values

LOG_ALL

public static final int LOG_ALL

See Also:

Constant Field Values

Constructor Detail

Debug

public Debug()

Method Detail

setDebug

public static void setDebug(boolean enable)

Enable or disable debug mode

By default, debug mode is enabled for development builds and disabled for exported APKs - see BuildConfig.DEBUG

Parameters:

enable - Enable debug mode ?

getDebug

public static boolean getDebug()

Is debug mode enabled ?

Returns:

Debug mode enabled

log

public static void log(java.lang.String message)

Log a "general" message

These messages are infrequent and mostly occur at startup/shutdown or on error

Parameters:

message - The message to log

logCommand

public static void logCommand(java.lang.String message)

Log a "per-command" message

This could produce a lot of output if the client runs many commands in the session

Parameters:

message - The message to log

logOutput

public static void logOutput(java.lang.String message)

Log a line of stdout/stderr output

This could produce a lot of output if the shell commands are noisy

Parameters:

message - The message to log

setLogTypeEnabled

public static void setLogTypeEnabled(int type,
                                     boolean enable)

Enable or disable logging specific types of message

You may | (or) LOG_* constants together. Note that debug mode must also be enabled for actual logging to occur.

Parameters:

type - LOG_* constants

enable - Enable or disable

getLogTypeEnabled

public static boolean getLogTypeEnabled(int type)

Is logging for specific types of messages enabled ?

You may | (or) LOG_* constants together, to learn if all passed message types are enabled for logging. Note that debug mode must also be enabled for actual logging to occur.

Parameters:

type - LOG_* constants

Returns:

enabled?

getLogTypeEnabledEffective

public static boolean getLogTypeEnabledEffective(int type)

Is logging for specific types of messages enabled ?

You may | (or) LOG_* constants together, to learn if all message types are enabled for logging. Takes debug mode into account for the result.

Parameters:

type - LOG_* constants

Returns:

enabled and in debug mode?

setOnLogListener

public static void setOnLogListener(Debug.OnLogListener onLogListener)

Register a custom log handler

Replaces the log method (write to logcat) with your own handler. Whether your handler gets called is still dependent on debug mode and message types being enabled for logging.

Parameters:

onLogListener - Custom log listener or NULL to revert to default

getOnLogListener

public static Debug.OnLogListener getOnLogListener()

Get the currently registered custom log handler

Returns:

Current custom log handler or NULL if none is present

setSanityChecksEnabled

public static void setSanityChecksEnabled(boolean enable)

Enable or disable sanity checks

Enables or disables the library crashing when su is called from the main thread.

Parameters:

enable - Enable or disable

getSanityChecksEnabled

public static boolean getSanityChecksEnabled()

Are sanity checks enabled ?

Note that debug mode must also be enabled for actual sanity checks to occur.

Returns:

True if enabled

getSanityChecksEnabledEffective

public static boolean getSanityChecksEnabledEffective()

Are sanity checks enabled ?

Takes debug mode into account for the result.

Returns:

True if enabled

onMainThread

public static boolean onMainThread()

Are we running on the main thread ?

Returns:

Running on main thread ?