org.apache.tools.ant
Class DefaultLogger
java.lang.Object
org.apache.tools.ant.DefaultLogger
- BuildListener, BuildLogger, EventListener
public class DefaultLogger
extends java.lang.Object
Writes build events to a PrintStream. Currently, it
only writes which targets are being executed, and
any messages that get logged.
static int | LEFT_COLUMN_SIZE - Size of left-hand column for right-justified task name.
|
protected boolean | emacsMode - Whether or not to use emacs-style output
|
protected PrintStream | err - PrintStream to write error messages to
|
protected static String | lSep - Line separator
|
protected int | msgOutputLevel - Lowest level of message to write out
|
protected PrintStream | out - PrintStream to write non-error messages to
|
void | buildFinished(BuildEvent event) - Prints whether the build succeeded or failed,
any errors the occurred during the build, and
how long the build took.
|
void | buildStarted(BuildEvent event) - Responds to a build being started by just remembering the current time.
|
protected static String | formatTime(long millis) - Convenience method to format a specified length of time.
|
protected void | log(String message) - Empty implementation which allows subclasses to receive the
same output that is generated here.
|
void | messageLogged(BuildEvent event) - Logs a message, if the priority is suitable.
|
protected void | printMessage(String message, PrintStream stream, int priority) - Prints a message to a PrintStream.
|
void | setEmacsMode(boolean emacsMode) - Sets this logger to produce emacs (and other editor) friendly output.
|
void | setErrorPrintStream(PrintStream err) - Sets the output stream to which this logger is to send error messages.
|
void | setMessageOutputLevel(int level) - Sets the highest level of message this logger should respond to.
|
void | setOutputPrintStream(PrintStream output) - Sets the output stream to which this logger is to send its output.
|
void | targetFinished(BuildEvent event) - No-op implementation.
|
void | targetStarted(BuildEvent event) - Logs a message to say that the target has started if this
logger allows information-level messages.
|
void | taskFinished(BuildEvent event) - No-op implementation.
|
void | taskStarted(BuildEvent event) - No-op implementation.
|
LEFT_COLUMN_SIZE
public static final int LEFT_COLUMN_SIZE
Size of left-hand column for right-justified task name.
emacsMode
protected boolean emacsMode
Whether or not to use emacs-style output
err
protected PrintStream err
PrintStream to write error messages to
lSep
protected static final String lSep
Line separator
msgOutputLevel
protected int msgOutputLevel
Lowest level of message to write out
out
protected PrintStream out
PrintStream to write non-error messages to
DefaultLogger
public DefaultLogger()
Sole constructor.
buildFinished
public void buildFinished(BuildEvent event)
Prints whether the build succeeded or failed,
any errors the occurred during the build, and
how long the build took.
- buildFinished in interface BuildListener
event
- An event with any relevant extra information.
Must not be null
.
formatTime
protected static String formatTime(long millis)
Convenience method to format a specified length of time.
millis
- Length of time to format, in milliseconds.
- the time as a formatted string.
log
protected void log(String message)
Empty implementation which allows subclasses to receive the
same output that is generated here.
message
- Message being logged. Should not be null
.
messageLogged
public void messageLogged(BuildEvent event)
Logs a message, if the priority is suitable.
In non-emacs mode, task level messages are prefixed by the
task name which is right-justified.
- messageLogged in interface BuildListener
event
- A BuildEvent containing message information.
Must not be null
.
printMessage
protected void printMessage(String message,
PrintStream stream,
int priority)
Prints a message to a PrintStream.
message
- The message to print.
Should not be null
.stream
- A PrintStream to print the message to.
Must not be null
.priority
- The priority of the message.
(Ignored in this implementation.)
setEmacsMode
public void setEmacsMode(boolean emacsMode)
Sets this logger to produce emacs (and other editor) friendly output.
- setEmacsMode in interface BuildLogger
emacsMode
- true
if output is to be unadorned so that
emacs and other editors can parse files names, etc.
setErrorPrintStream
public void setErrorPrintStream(PrintStream err)
Sets the output stream to which this logger is to send error messages.
- setErrorPrintStream in interface BuildLogger
err
- The error stream for the logger.
Must not be null
.
setMessageOutputLevel
public void setMessageOutputLevel(int level)
Sets the highest level of message this logger should respond to.
Only messages with a message level lower than or equal to the
given level should be written to the log.
Constants for the message levels are in the
Project
class. The order of the levels, from least
to most verbose, is
MSG_ERR
,
MSG_WARN
,
MSG_INFO
,
MSG_VERBOSE
,
MSG_DEBUG
.
The default message level for DefaultLogger is Project.MSG_ERR.
- setMessageOutputLevel in interface BuildLogger
level
- the logging level for the logger.
setOutputPrintStream
public void setOutputPrintStream(PrintStream output)
Sets the output stream to which this logger is to send its output.
- setOutputPrintStream in interface BuildLogger
output
- The output stream for the logger.
Must not be null
.
targetStarted
public void targetStarted(BuildEvent event)
Logs a message to say that the target has started if this
logger allows information-level messages.
- targetStarted in interface BuildListener
event
- An event with any relevant extra information.
Must not be null
.
Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.