de.mindpipe.android.logging.log4j
Class LogConfigurator

java.lang.Object
  de.mindpipe.android.logging.log4j.LogConfigurator

public class LogConfigurator
extends Object

Configures the Log4j logging framework. See Patterns for pattern layout.

Author:

Rolf Kulemann

Constructor Summary

LogConfigurator()

LogConfigurator(String fileName)

LogConfigurator(String fileName, int maxBackupSize, long maxFileSize, String filePattern, org.apache.log4j.Level rootLevel)

LogConfigurator(String fileName, org.apache.log4j.Level rootLevel)

LogConfigurator(String fileName, org.apache.log4j.Level rootLevel, String filePattern)

Method Summary

void	configure()
String	getFileName() Returns the name of the log file
String	getFilePattern()
String	getLogCatPattern()
int	getMaxBackupSize() Returns the maximum number of backed up log files
long	getMaxFileSize() Returns the maximum size of log file until rolling
org.apache.log4j.Level	getRootLevel() Return the log level of the root logger
boolean	isImmediateFlush()
boolean	isInternalDebugging()
boolean	isResetConfiguration() Resets the log4j configuration before applying this configuration.
boolean	isUseFileAppender() Returns true, if FileAppender is used for logging
boolean	isUseLogCatAppender() Returns true, if LogcatAppender should be used
void	setFileName(String fileName) Sets the name of the log file
void	setFilePattern(String filePattern)
void	setImmediateFlush(boolean immediateFlush)
void	setInternalDebugging(boolean internalDebugging)
void	setLevel(String loggerName, org.apache.log4j.Level level) Sets the level of logger with name loggerName.
void	setLogCatPattern(String logCatPattern)
void	setMaxBackupSize(int maxBackupSize) Sets the maximum number of backed up log files
void	setMaxFileSize(long maxFileSize) Sets the maximum size of log file until rolling
void	setResetConfiguration(boolean resetConfiguration)
void	setRootLevel(org.apache.log4j.Level level) Sets log level for the root logger
void	setUseFileAppender(boolean useFileAppender)
void	setUseLogCatAppender(boolean useLogCatAppender) If set to true, LogCatAppender will be used for logging

Methods inherited from class java.lang.Object

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

Constructor Detail

LogConfigurator

public LogConfigurator()

LogConfigurator

public LogConfigurator(String fileName)

Parameters:

fileName - Name of the log file

LogConfigurator

public LogConfigurator(String fileName,
                       org.apache.log4j.Level rootLevel)

Parameters:

fileName - Name of the log file

rootLevel - Log level for the root logger

LogConfigurator

public LogConfigurator(String fileName,
                       org.apache.log4j.Level rootLevel,
                       String filePattern)

Parameters:

fileName - Name of the log file

rootLevel - Log level for the root logger

filePattern - Log pattern for the file appender

LogConfigurator

public LogConfigurator(String fileName,
                       int maxBackupSize,
                       long maxFileSize,
                       String filePattern,
                       org.apache.log4j.Level rootLevel)

Parameters:

fileName - Name of the log file

maxBackupSize - Maximum number of backed up log files

maxFileSize - Maximum size of log file until rolling

filePattern - Log pattern for the file appender

rootLevel - Log level for the root logger

Method Detail

configure

public void configure()

setLevel

public void setLevel(String loggerName,
                     org.apache.log4j.Level level)

Sets the level of logger with name loggerName. Corresponds to log4j.properties log4j.logger.org.apache.what.ever=ERROR

Parameters:

loggerName -

level -

getRootLevel

public org.apache.log4j.Level getRootLevel()

Return the log level of the root logger

Returns:

Log level of the root logger

setRootLevel

public void setRootLevel(org.apache.log4j.Level level)

Sets log level for the root logger

Parameters:

level - Log level for the root logger

getFilePattern

public String getFilePattern()

setFilePattern

public void setFilePattern(String filePattern)

getLogCatPattern

public String getLogCatPattern()

setLogCatPattern

public void setLogCatPattern(String logCatPattern)

getFileName

public String getFileName()

Returns the name of the log file

Returns:

the name of the log file

setFileName

public void setFileName(String fileName)

Sets the name of the log file

Parameters:

fileName - Name of the log file

getMaxBackupSize

public int getMaxBackupSize()

Returns the maximum number of backed up log files

Returns:

Maximum number of backed up log files

setMaxBackupSize

public void setMaxBackupSize(int maxBackupSize)

Sets the maximum number of backed up log files

Parameters:

maxBackupSize - Maximum number of backed up log files

getMaxFileSize

public long getMaxFileSize()

Returns the maximum size of log file until rolling

Returns:

Maximum size of log file until rolling

setMaxFileSize

public void setMaxFileSize(long maxFileSize)

Sets the maximum size of log file until rolling

Parameters:

maxFileSize - Maximum size of log file until rolling

isImmediateFlush

public boolean isImmediateFlush()

setImmediateFlush

public void setImmediateFlush(boolean immediateFlush)

isUseFileAppender

public boolean isUseFileAppender()

Returns true, if FileAppender is used for logging

Returns:

True, if FileAppender is used for logging

setUseFileAppender

public void setUseFileAppender(boolean useFileAppender)

Parameters:

useFileAppender - the useFileAppender to set

isUseLogCatAppender

public boolean isUseLogCatAppender()

Returns true, if LogcatAppender should be used

Returns:

True, if LogcatAppender should be used

setUseLogCatAppender

public void setUseLogCatAppender(boolean useLogCatAppender)

If set to true, LogCatAppender will be used for logging

Parameters:

useLogCatAppender - If true, LogCatAppender will be used for logging

setResetConfiguration

public void setResetConfiguration(boolean resetConfiguration)

isResetConfiguration

public boolean isResetConfiguration()

Resets the log4j configuration before applying this configuration. Default is true.

Returns:

True, if the log4j configuration should be reset before applying this configuration.

setInternalDebugging

public void setInternalDebugging(boolean internalDebugging)

isInternalDebugging

public boolean isInternalDebugging()