com.salesforce.androidsdk.analytics.logger

Class SalesforceLogger

java.lang.Object

com.salesforce.androidsdk.analytics.logger.SalesforceLogger

public class SalesforceLogger
extends java.lang.Object

A simple logger that allows components to log statements of different log levels. This class also provides the ability to break down logs at the component level and set different log levels for different components. The available options for log output are console and file.

Author:

bhariharan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SalesforceLogger.Level An enumeration of log levels.

Method Summary

Modifier and Type	Method and Description
void	d(java.lang.String tag, java.lang.String message) Logs a debug log line.
void	d(java.lang.String tag, java.lang.String message, java.lang.Throwable e) Logs a debug log line.
void	disableFileLogging() Disables file logging.
void	e(java.lang.String tag, java.lang.String message) Logs an error log line.
void	e(java.lang.String tag, java.lang.String message, java.lang.Throwable e) Logs an error log line.
void	enableFileLogging(int maxSize) Enables file logging.
static void	flushComponents() Wipes all components currently being logged.
static java.util.Set<java.lang.String>	getComponents() Returns the set of components that have loggers associated with them.
FileLogger	getFileLogger() Returns the instance of FileLogger associated with this component.
static SalesforceLogger	getLogger(java.lang.String componentName, Context context) Returns a logger instance associated with a named component.
SalesforceLogger.Level	getLogLevel() Returns the log level currently being used.
void	i(java.lang.String tag, java.lang.String message) Logs an info log line.
void	i(java.lang.String tag, java.lang.String message, java.lang.Throwable e) Logs an info log line.
boolean	isFileLoggingEnabled() Returns if file logging is enabled or not.
void	log(SalesforceLogger.Level level, java.lang.String tag, java.lang.String message) Logs a log line of the specified level.
void	log(SalesforceLogger.Level level, java.lang.String tag, java.lang.String message, java.lang.Throwable e) Logs a log line of the specified level.
static void	resetLoggerPrefs(Context context) Resets the stored logger prefs.
void	setLogLevel(SalesforceLogger.Level level) Sets the log level to be used.
void	v(java.lang.String tag, java.lang.String message) Logs a verbose log line.
void	v(java.lang.String tag, java.lang.String message, java.lang.Throwable e) Logs a verbose log line.
void	w(java.lang.String tag, java.lang.String message) Logs a warning log line.
void	w(java.lang.String tag, java.lang.String message, java.lang.Throwable e) Logs a warning log line.

Methods inherited from class java.lang.Object

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

Method Detail

getLogger

public static SalesforceLogger getLogger(java.lang.String componentName,
                                         Context context)

Returns a logger instance associated with a named component.

Parameters:

componentName - Component name.

context - Context.

Returns:

Logger instance.

getComponents

public static java.util.Set<java.lang.String> getComponents()

Returns the set of components that have loggers associated with them.

Returns:

Set of components being logged.

flushComponents

public static void flushComponents()

Wipes all components currently being logged. Used only by tests.

getFileLogger

public FileLogger getFileLogger()

Returns the instance of FileLogger associated with this component.

Returns:

FileLogger instance.

getLogLevel

public SalesforceLogger.Level getLogLevel()

Returns the log level currently being used.

Returns:

Log level.

setLogLevel

public void setLogLevel(SalesforceLogger.Level level)

Sets the log level to be used.

Parameters:

level - Log level.

disableFileLogging

public void disableFileLogging()

Disables file logging.

enableFileLogging

public void enableFileLogging(int maxSize)

Enables file logging.

Parameters:

maxSize - Maximum number of log lines allowed to be stored at a time.

isFileLoggingEnabled

public boolean isFileLoggingEnabled()

Returns if file logging is enabled or not.

Returns:

True - if enabled, False - otherwise.

e

public void e(java.lang.String tag,
              java.lang.String message)

Logs an error log line.

Parameters:

tag - Log tag.

message - Log message.

e

public void e(java.lang.String tag,
              java.lang.String message,
              java.lang.Throwable e)

Logs an error log line.

Parameters:

tag - Log tag.

message - Log message.

e - Exception to be logged.

w

public void w(java.lang.String tag,
              java.lang.String message)

Logs a warning log line.

Parameters:

tag - Log tag.

message - Log message.

w

public void w(java.lang.String tag,
              java.lang.String message,
              java.lang.Throwable e)

Logs a warning log line.

Parameters:

tag - Log tag.

message - Log message.

e - Exception to be logged.

i

public void i(java.lang.String tag,
              java.lang.String message)

Logs an info log line.

Parameters:

tag - Log tag.

message - Log message.

i

public void i(java.lang.String tag,
              java.lang.String message,
              java.lang.Throwable e)

Logs an info log line.

Parameters:

tag - Log tag.

message - Log message.

e - Exception to be logged.

d

public void d(java.lang.String tag,
              java.lang.String message)

Logs a debug log line.

Parameters:

tag - Log tag.

message - Log message.

d

public void d(java.lang.String tag,
              java.lang.String message,
              java.lang.Throwable e)

Logs a debug log line.

Parameters:

tag - Log tag.

message - Log message.

e - Exception to be logged.

v

public void v(java.lang.String tag,
              java.lang.String message)

Logs a verbose log line.

Parameters:

tag - Log tag.

message - Log message.

v

public void v(java.lang.String tag,
              java.lang.String message,
              java.lang.Throwable e)

Logs a verbose log line.

Parameters:

tag - Log tag.

message - Log message.

e - Exception to be logged.

log

public void log(SalesforceLogger.Level level,
                java.lang.String tag,
                java.lang.String message)

Logs a log line of the specified level.

Parameters:

level - Log level.

tag - Log tag.

message - Log message.

log

public void log(SalesforceLogger.Level level,
                java.lang.String tag,
                java.lang.String message,
                java.lang.Throwable e)

Logs a log line of the specified level.

Parameters:

level - Log level.

tag - Log tag.

message - Log message.

e - Exception to be logged.

resetLoggerPrefs

public static void resetLoggerPrefs(Context context)

Resets the stored logger prefs. Should be used ONLY by tests.

Parameters:

context - Context.