org.apache.tools.ant.taskdefs
Class RecorderEntry

java.lang.Object
  |
  +--org.apache.tools.ant.taskdefs.RecorderEntry

All Implemented Interfaces:

BuildListener, BuildLogger, java.util.EventListener

public class RecorderEntry

extends java.lang.Object

implements BuildLogger

This is a class that represents a recorder. This is the listener to the build process.

Version:

0.5

Author:

J D Glanville

Constructor Summary

protected

RecorderEntry(java.lang.String name)

Method Summary

void	buildFinished(BuildEvent event) Fired after the last target has finished.
void	buildStarted(BuildEvent event) Fired before any targets are started.
java.lang.String	getFilename()
void	messageLogged(BuildEvent event) Fired whenever a message is logged.
void	setEmacsMode(boolean emacsMode) Set this logger to produce emacs (and other editor) friendly output.
void	setErrorPrintStream(java.io.PrintStream err) Set the output stream to which this logger is to send error messages.
void	setMessageOutputLevel(int level) Set the msgOutputLevel this logger is to respond to.
void	setOutputPrintStream(java.io.PrintStream output) Set the output stream to which this logger is to send its output.
void	setRecordState(java.lang.Boolean state) Turns off or on this recorder.
void	targetFinished(BuildEvent event) Fired when a target has finished.
void	targetStarted(BuildEvent event) Fired when a target is started.
void	taskFinished(BuildEvent event) Fired when a task has finished.
void	taskStarted(BuildEvent event) Fired when a task is started.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecorderEntry

protected RecorderEntry(java.lang.String name)

Parameters:

name - The name of this recorder (used as the filename).

Method Detail

getFilename

public java.lang.String getFilename()

Returns:

the name of the file the output is sent to.

setRecordState

public void setRecordState(java.lang.Boolean state)

Turns off or on this recorder.

Parameters:

state - true for on, false for off, null for no change.

buildStarted

public void buildStarted(BuildEvent event)

Description copied from interface: BuildListener

Fired before any targets are started.

Specified by:

buildStarted in interface BuildListener

buildFinished

public void buildFinished(BuildEvent event)

Description copied from interface: BuildListener

Fired after the last target has finished. This event will still be thrown if an error occured during the build.

Specified by:

buildFinished in interface BuildListener

Following copied from interface: org.apache.tools.ant.BuildListener

See Also:

BuildEvent.getException()

targetStarted

public void targetStarted(BuildEvent event)

Description copied from interface: BuildListener

Fired when a target is started.

Specified by:

targetStarted in interface BuildListener

Following copied from interface: org.apache.tools.ant.BuildListener

See Also:

BuildEvent.getTarget()

targetFinished

public void targetFinished(BuildEvent event)

Description copied from interface: BuildListener

Fired when a target has finished. This event will still be thrown if an error occured during the build.

Specified by:

targetFinished in interface BuildListener

Following copied from interface: org.apache.tools.ant.BuildListener

See Also:

BuildEvent.getException()

taskStarted

public void taskStarted(BuildEvent event)

Description copied from interface: BuildListener

Fired when a task is started.

Specified by:

taskStarted in interface BuildListener

Following copied from interface: org.apache.tools.ant.BuildListener

See Also:

BuildEvent.getTask()

taskFinished

public void taskFinished(BuildEvent event)

Description copied from interface: BuildListener

Fired when a task has finished. This event will still be throw if an error occured during the build.

Specified by:

taskFinished in interface BuildListener

Following copied from interface: org.apache.tools.ant.BuildListener

See Also:

BuildEvent.getException()

messageLogged

public void messageLogged(BuildEvent event)

Description copied from interface: BuildListener

Fired whenever a message is logged.

Specified by:

messageLogged in interface BuildListener

Following copied from interface: org.apache.tools.ant.BuildListener

See Also:

BuildEvent.getMessage(), BuildEvent.getPriority()

setMessageOutputLevel

public void setMessageOutputLevel(int level)

Description copied from interface: BuildLogger

Set the msgOutputLevel this logger is to respond to. Only messages with a message level lower than or equal to the given level are output to the log.

Constants for the message levels are in Project.java. The order of the levels, from least to most verbose, is MSG_ERR, MSG_WARN, MSG_INFO, MSG_VERBOSE, MSG_DEBUG.

Specified by:

setMessageOutputLevel in interface BuildLogger

Following copied from interface: org.apache.tools.ant.BuildLogger

Parameters:

level - the logging level for the logger.

setOutputPrintStream

public void setOutputPrintStream(java.io.PrintStream output)

Description copied from interface: BuildLogger

Set the output stream to which this logger is to send its output.

Specified by:

setOutputPrintStream in interface BuildLogger

Following copied from interface: org.apache.tools.ant.BuildLogger

Parameters:

output - the output stream for the logger.

setEmacsMode

public void setEmacsMode(boolean emacsMode)

Description copied from interface: BuildLogger

Set this logger to produce emacs (and other editor) friendly output.

Specified by:

setEmacsMode in interface BuildLogger

Following copied from interface: org.apache.tools.ant.BuildLogger

Parameters:

emacsMode - true if output is to be unadorned so that emacs and other editors can parse files names, etc.

setErrorPrintStream

public void setErrorPrintStream(java.io.PrintStream err)

Description copied from interface: BuildLogger

Set the output stream to which this logger is to send error messages.

Specified by:

setErrorPrintStream in interface BuildLogger

Following copied from interface: org.apache.tools.ant.BuildLogger

Parameters:

err - the error stream for the logger.