protoj.core
Class ProtoLogger

java.lang.Object
  protoj.core.ProtoLogger

public final class ProtoLogger
extends java.lang.Object

Log4j wrapper class for protoj logging. Two common appenders are supported via the setConsoleAppenderEnabled(boolean) and setFileAppenderEnabled(boolean, java.lang.String) methods - simply call none, one or both methods as required. The resulting appenders that get created are assigned a default pattern.

This class uses a protoj rather than the global root logger so that there is no conflict with other libraries in the same jvm that are also using log4j.

Author:

Ashley Williams BUG: ajc task logging doesn't work unless I add appender to root logger don't want to though because that enables appenders for other libraries also

Constructor Summary

ProtoLogger(CoreProject parent)
Creates an instance with the owning project.

Method Summary

org.apache.log4j.Logger	getAntLogger()
java.lang.String	getConsolePattern()
java.lang.String	getFilePattern()
org.apache.log4j.Logger	getProtoLogger()
org.apache.log4j.ConsoleAppender	setConsoleAppenderEnabled(boolean enable) Adds or removes a new console consoleAppender to the log4j loggers.
org.apache.log4j.RollingFileAppender	setFileAppenderEnabled(boolean enable, java.lang.String logFile) Adds or removes a new rolling file appender to the log4j loggers.
void	setLevel(org.apache.log4j.Level level)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtoLogger

public ProtoLogger(CoreProject parent)

Creates an instance with the owning project. After this constructor returns a file appender will be active.

Parameters:

parent -

Method Detail

setConsoleAppenderEnabled

public org.apache.log4j.ConsoleAppender setConsoleAppenderEnabled(boolean enable)

Adds or removes a new console consoleAppender to the log4j loggers. When adding, if an appender already exists with the same name then nothing will happen. When removing, if no appender exists with the same name then nothing will happen.

Parameters:

enable - true to create and add a new appender, false to remove any existing appender

Returns:

setFileAppenderEnabled

public org.apache.log4j.RollingFileAppender setFileAppenderEnabled(boolean enable,
                                                                   java.lang.String logFile)

Adds or removes a new rolling file appender to the log4j loggers. When adding, if an appender already exists with the same name then nothing will happen. When removing, if no appender exists with the same name then nothing will happen.

Parameters:

enable - true to create and add a new appender, false to remove any existing appender

logFile - the log file to be written to, also used in the name of the appender

Returns:

getConsolePattern

public java.lang.String getConsolePattern()

getFilePattern

public java.lang.String getFilePattern()

getProtoLogger

public org.apache.log4j.Logger getProtoLogger()

getAntLogger

public org.apache.log4j.Logger getAntLogger()

setLevel

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