com.tomasteubner.common.logging.impl

Class SimpleAndroidLogger

java.lang.Object

com.tomasteubner.common.logging.impl.LoggerBase

com.tomasteubner.common.logging.impl.SimpleAndroidLogger

All Implemented Interfaces:

Logger

public class SimpleAndroidLogger
extends LoggerBase

Field Summary

Fields

Modifier and Type	Field and Description
protected static Properties	androidLogProps Properties loaded from androidlog.properties
protected int	currentLogLevel The current log level
protected static DateFormat	dateFormatter Used to format times.
protected static String	dateTimeFormat The date and time format to use in the log message
protected static String	DEFAULT_DATE_TIME_FORMAT The default format to use when formating dates
static int	LOG_LEVEL_ALL Enable all logging levels
static int	LOG_LEVEL_DEBUG "Debug" level logging.
static int	LOG_LEVEL_ERROR "Error" level logging.
static int	LOG_LEVEL_FATAL "Fatal" level logging.
static int	LOG_LEVEL_INFO "Info" level logging.
static int	LOG_LEVEL_OFF Enable no logging levels
static int	LOG_LEVEL_TRACE "Trace" level logging.
static int	LOG_LEVEL_WARN "Warn" level logging.
protected String	logName The name of this android log instance
protected static boolean	showDateTime Include the current time in the log message
protected static boolean	showLevel Include the current time in the log message
protected static boolean	showLogName Include the instance name in the log message?
protected static boolean	showShortName Include the short name ( last component ) of the logger in the log message.
protected static boolean	showShortTag Include the short tag ( last component ) of the logger in the android log cat.
protected static String	systemPrefix All system properties used by AndroidLog start with this

Constructor Summary

Constructors

Constructor and Description
SimpleAndroidLogger(String name) Construct an Android log with given name.

Method Summary

Modifier and Type	Method and Description
protected void	debugImpl(String message) Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_DEBUG.
protected void	debugImpl(String message, Throwable t) Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_DEBUG.
protected void	errorImpl(String message) Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_ERROR.
protected void	errorImpl(String message, Throwable t) Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_ERROR.
protected void	fatalImpl(String message) Log a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_FATAL.
protected void	fatalImpl(String message, Throwable t) Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_FATAL.
protected static ClassLoader	getClassLoader(Class<?> clazz)
int	getLevel() Get logging level.
protected void	infoImpl(String message) Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_INFO.
protected void	infoImpl(String message, Throwable t) Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_INFO.
boolean	isDebugEnabled() Are debug messages currently enabled?
boolean	isErrorEnabled() Are error messages currently enabled?
boolean	isFatalEnabled() Are fatal messages currently enabled?
boolean	isInfoEnabled() Are info messages currently enabled?
protected boolean	isLevelEnabled(int logLevel) Is the given log level currently enabled?
boolean	isTraceEnabled() Are trace messages currently enabled?
boolean	isWarnEnabled() Are warn messages currently enabled?
protected void	log(int type, Object message, Throwable t) Do the actual logging.
void	setLevel(int currentLogLevel) Set logging level.
protected void	traceImpl(String message) Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_TRACE.
protected void	traceImpl(String message, Throwable t) Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_TRACE.
protected void	warnImpl(String message) Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_WARN.
protected void	warnImpl(String message, Throwable t) Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_WARN.
protected void	write(StringBuffer buffer) Write the content of the message accumulated in the specified StringBuffer to the appropriate output destination.

Methods inherited from class com.tomasteubner.common.logging.impl.LoggerBase

debug, debug, error, error, fatal, fatal, info, info, trace, trace, warn, warn

Methods inherited from class java.lang.Object

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

Field Detail

systemPrefix

protected static final String systemPrefix

All system properties used by AndroidLog start with this

See Also:

Constant Field Values

androidLogProps

protected static final Properties androidLogProps

Properties loaded from androidlog.properties

DEFAULT_DATE_TIME_FORMAT

protected static final String DEFAULT_DATE_TIME_FORMAT

The default format to use when formating dates

See Also:

Constant Field Values

showLogName

protected static boolean showLogName

Include the instance name in the log message?

showShortName

protected static boolean showShortName

Include the short name ( last component ) of the logger in the log message. Defaults to true - otherwise we'll be lost in a flood of messages without knowing who sends them.

showDateTime

protected static boolean showDateTime

Include the current time in the log message

dateTimeFormat

protected static String dateTimeFormat

The date and time format to use in the log message

showLevel

protected static boolean showLevel

Include the current time in the log message

showShortTag

protected static boolean showShortTag

Include the short tag ( last component ) of the logger in the android log cat. Defaults to false

dateFormatter

protected static DateFormat dateFormatter

Used to format times.

Any code that accesses this object should first obtain a lock on it, ie use synchronized(dateFormatter); this requirement was introduced in 1.1.1 to fix an existing thread safety bug (SimpleDateFormat.format is not thread-safe).

LOG_LEVEL_TRACE

public static final int LOG_LEVEL_TRACE

"Trace" level logging.

See Also:

Constant Field Values

LOG_LEVEL_DEBUG

public static final int LOG_LEVEL_DEBUG

"Debug" level logging.

See Also:

Constant Field Values

LOG_LEVEL_INFO

public static final int LOG_LEVEL_INFO

"Info" level logging.

See Also:

Constant Field Values

LOG_LEVEL_WARN

public static final int LOG_LEVEL_WARN

"Warn" level logging.

See Also:

Constant Field Values

LOG_LEVEL_ERROR

public static final int LOG_LEVEL_ERROR

"Error" level logging.

See Also:

Constant Field Values

LOG_LEVEL_FATAL

public static final int LOG_LEVEL_FATAL

"Fatal" level logging.

See Also:

Constant Field Values

LOG_LEVEL_ALL

public static final int LOG_LEVEL_ALL

Enable all logging levels

See Also:

Constant Field Values

LOG_LEVEL_OFF

public static final int LOG_LEVEL_OFF

Enable no logging levels

See Also:

Constant Field Values

logName

protected String logName

The name of this android log instance

currentLogLevel

protected int currentLogLevel

The current log level

Constructor Detail

SimpleAndroidLogger

public SimpleAndroidLogger(String name)

Construct an Android log with given name.

Parameters:

name - log name

Method Detail

getClassLoader

protected static ClassLoader getClassLoader(Class<?> clazz)

setLevel

public void setLevel(int currentLogLevel)

Set logging level.

Parameters:

currentLogLevel - new logging level

getLevel

public int getLevel()

Get logging level.

Returns:

the level

log

protected void log(int type,
                   Object message,
                   Throwable t)

Do the actual logging. This method assembles the message and then calls write() to cause it to be written.
Calls Log to write log for the Android platform.

Parameters:

type - One of the LOG_LEVEL_XXX constants defining the log level

message - The message itself (typically a String)

t - The exception whose stack trace should be logged

write

protected void write(StringBuffer buffer)

Write the content of the message accumulated in the specified StringBuffer to the appropriate output destination. The default implementation writes to System.err.

Parameters:

buffer - A StringBuffer containing the accumulated text to be logged

isLevelEnabled

protected boolean isLevelEnabled(int logLevel)

Is the given log level currently enabled?

Parameters:

logLevel - is this level enabled?

Returns:

true if enabled

isTraceEnabled

public boolean isTraceEnabled()

Are trace messages currently enabled?

This allows expensive operations such as String concatenation to be avoided when the message will be ignored by the logger.

Returns:

true if trace is enabled in the underlying logger.

isDebugEnabled

public boolean isDebugEnabled()

Are debug messages currently enabled?

This allows expensive operations such as String concatenation to be avoided when the message will be ignored by the logger.

Returns:

true if debug is enabled in the underlying logger.

isInfoEnabled

public boolean isInfoEnabled()

Are info messages currently enabled?

This allows expensive operations such as String concatenation to be avoided when the message will be ignored by the logger.

Returns:

true if info is enabled in the underlying logger.

isWarnEnabled

public boolean isWarnEnabled()

Are warn messages currently enabled?

This allows expensive operations such as String concatenation to be avoided when the message will be ignored by the logger.

Returns:

true if warning is enabled in the underlying logger.

isErrorEnabled

public boolean isErrorEnabled()

Are error messages currently enabled?

This allows expensive operations such as String concatenation to be avoided when the message will be ignored by the logger.

Returns:

true if error is enabled in the underlying logger.

isFatalEnabled

public boolean isFatalEnabled()

Are fatal messages currently enabled?

This allows expensive operations such as String concatenation to be avoided when the message will be ignored by the logger.

Returns:

true if fatal is enabled in the underlying logger.

traceImpl

protected void traceImpl(String message,
                         Throwable t)

Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_TRACE.

Specified by:

traceImpl in class LoggerBase

Parameters:

message - to log

t - log this cause

See Also:

Log.trace(Object, Throwable)

traceImpl

protected void traceImpl(String message)

Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_TRACE.

Specified by:

traceImpl in class LoggerBase

Parameters:

message - to log

See Also:

Log.trace(Object)

debugImpl

protected void debugImpl(String message,
                         Throwable t)

Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_DEBUG.

Specified by:

debugImpl in class LoggerBase

Parameters:

message - to log

t - log this cause

See Also:

Log.debug(Object, Throwable)

debugImpl

protected void debugImpl(String message)

Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_DEBUG.

Specified by:

debugImpl in class LoggerBase

Parameters:

message - to log

See Also:

Log.debug(Object)

infoImpl

protected void infoImpl(String message,
                        Throwable t)

Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_INFO.

Specified by:

infoImpl in class LoggerBase

Parameters:

message - to log

t - log this cause

See Also:

Log.info(Object, Throwable)

infoImpl

protected void infoImpl(String message)

Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_INFO.

Specified by:

infoImpl in class LoggerBase

Parameters:

message - to log

See Also:

Log.info(Object)

warnImpl

protected void warnImpl(String message,
                        Throwable t)

Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_WARN.

Specified by:

warnImpl in class LoggerBase

Parameters:

message - to log

t - log this cause

See Also:

Log.warn(Object, Throwable)

warnImpl

protected void warnImpl(String message)

Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_WARN.

Specified by:

warnImpl in class LoggerBase

Parameters:

message - to log

See Also:

Log.warn(Object)

errorImpl

protected void errorImpl(String message,
                         Throwable t)

Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_ERROR.

Specified by:

errorImpl in class LoggerBase

Parameters:

message - to log

t - log this cause

See Also:

Log.error(Object, Throwable)

errorImpl

protected void errorImpl(String message)

Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_ERROR.

Specified by:

errorImpl in class LoggerBase

Parameters:

message - to log

See Also:

Log.error(Object)

fatalImpl

protected void fatalImpl(String message,
                         Throwable t)

Logs a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_FATAL.

Specified by:

fatalImpl in class LoggerBase

Parameters:

message - to log

t - log this cause

See Also:

Log.fatal(Object, Throwable)

fatalImpl

protected void fatalImpl(String message)

Log a message with org.apache.commons.logging.impl.AndroidLog.LOG_LEVEL_FATAL.

Specified by:

fatalImpl in class LoggerBase

Parameters:

message - to log

See Also:

Log.fatal(Object)