Package org.apache.tools.ant.taskdefs
Class RecorderEntry
- java.lang.Object
- 
- org.apache.tools.ant.taskdefs.RecorderEntry
 
- 
- All Implemented Interfaces:
- java.util.EventListener,- BuildListener,- BuildLogger,- SubBuildListener
 
 public class RecorderEntry extends java.lang.Object implements BuildLogger, SubBuildListener This is a class that represents a recorder. This is the listener to the build process.- Since:
- Ant 1.4
 
- 
- 
Constructor SummaryConstructors Modifier Constructor Description protectedRecorderEntry(java.lang.String name)
 - 
Method SummaryModifier and Type Method Description voidbuildFinished(BuildEvent event)Signals that the last target has finished.voidbuildStarted(BuildEvent event)Signals that a build has started.voidcleanup()java.lang.StringgetFilename()ProjectgetProject()Get the project associated with this recorder entry.voidmessageLogged(BuildEvent event)Signals a message logging event.voidsetEmacsMode(boolean emacsMode)Sets this logger to produce emacs (and other editor) friendly output.voidsetErrorPrintStream(java.io.PrintStream err)Sets the output stream to which this logger is to send error messages.voidsetMessageOutputLevel(int level)Sets the highest level of message this logger should respond to.voidsetOutputPrintStream(java.io.PrintStream output)Sets the output stream to which this logger is to send its output.voidsetProject(Project project)Set the project associated with this recorder entry.voidsetRecordState(java.lang.Boolean state)Turns off or on this recorder.voidsubBuildFinished(BuildEvent event)Cleans up any resources held by this recorder entry at the end of a subbuild if it has been created for the subbuild's project instance.voidsubBuildStarted(BuildEvent event)Empty implementation to satisfy the BuildListener interface.voidtargetFinished(BuildEvent event)Signals that a target has finished.voidtargetStarted(BuildEvent event)Signals that a target is starting.voidtaskFinished(BuildEvent event)Signals that a task has finished.voidtaskStarted(BuildEvent event)Signals that a task is starting.
 
- 
- 
- 
Method Detail- 
getFilenamepublic java.lang.String getFilename() - Returns:
- the name of the file the output is sent to.
 
 - 
setRecordStatepublic void setRecordState(java.lang.Boolean state) Turns off or on this recorder.- Parameters:
- state- true for on, false for off, null for no change.
 
 - 
buildStartedpublic void buildStarted(BuildEvent event) Description copied from interface:BuildListenerSignals that a build has started. This event is fired before any targets have started.This event is fired before the project instance is fully configured. In particular no properties have been set and the project may not know its name or default target, yet. - Specified by:
- buildStartedin interface- BuildListener
- Parameters:
- event- An event with any relevant extra information. Must not be- null.
- See Also:
- .
 
 - 
buildFinishedpublic void buildFinished(BuildEvent event) Description copied from interface:BuildListenerSignals that the last target has finished. This event will still be fired if an error occurred during the build.- Specified by:
- buildFinishedin interface- BuildListener
- Parameters:
- event- An event with any relevant extra information. Must not be- null.
- See Also:
- .
 
 - 
subBuildFinishedpublic void subBuildFinished(BuildEvent event) Cleans up any resources held by this recorder entry at the end of a subbuild if it has been created for the subbuild's project instance.- Specified by:
- subBuildFinishedin interface- SubBuildListener
- Parameters:
- event- the buildFinished event
- Since:
- Ant 1.6.2
- See Also:
- BuildEvent.getException()
 
 - 
subBuildStartedpublic void subBuildStarted(BuildEvent event) Empty implementation to satisfy the BuildListener interface.- Specified by:
- subBuildStartedin interface- SubBuildListener
- Parameters:
- event- the buildStarted event
- Since:
- Ant 1.6.2
 
 - 
targetStartedpublic void targetStarted(BuildEvent event) Description copied from interface:BuildListenerSignals that a target is starting.- Specified by:
- targetStartedin interface- BuildListener
- Parameters:
- event- An event with any relevant extra information. Must not be- null.
- See Also:
- .
 
 - 
targetFinishedpublic void targetFinished(BuildEvent event) Description copied from interface:BuildListenerSignals that a target has finished. This event will still be fired if an error occurred during the build.- Specified by:
- targetFinishedin interface- BuildListener
- Parameters:
- event- An event with any relevant extra information. Must not be- null.
- See Also:
- .
 
 - 
taskStartedpublic void taskStarted(BuildEvent event) Description copied from interface:BuildListenerSignals that a task is starting.- Specified by:
- taskStartedin interface- BuildListener
- Parameters:
- event- An event with any relevant extra information. Must not be- null.
- See Also:
- .
 
 - 
taskFinishedpublic void taskFinished(BuildEvent event) Description copied from interface:BuildListenerSignals that a task has finished. This event will still be fired if an error occurred during the build.- Specified by:
- taskFinishedin interface- BuildListener
- Parameters:
- event- An event with any relevant extra information. Must not be- null.
- See Also:
- .
 
 - 
messageLoggedpublic void messageLogged(BuildEvent event) Description copied from interface:BuildListenerSignals a message logging event.- Specified by:
- messageLoggedin interface- BuildListener
- Parameters:
- event- An event with any relevant extra information. Must not be- null.
- See Also:
- .
 
 - 
setMessageOutputLevelpublic void setMessageOutputLevel(int level) Description copied from interface:BuildLoggerSets 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 Projectclass. The order of the levels, from least to most verbose, isMSG_ERR,MSG_WARN,MSG_INFO,MSG_VERBOSE,MSG_DEBUG.- Specified by:
- setMessageOutputLevelin interface- BuildLogger
- Parameters:
- level- the logging level for the logger.
- See Also:
- .
 
 - 
setOutputPrintStreampublic void setOutputPrintStream(java.io.PrintStream output) Description copied from interface:BuildLoggerSets the output stream to which this logger is to send its output.- Specified by:
- setOutputPrintStreamin interface- BuildLogger
- Parameters:
- output- The output stream for the logger. Must not be- null.
- See Also:
- .
 
 - 
setEmacsModepublic void setEmacsMode(boolean emacsMode) Description copied from interface:BuildLoggerSets this logger to produce emacs (and other editor) friendly output.- Specified by:
- setEmacsModein interface- BuildLogger
- Parameters:
- emacsMode-- trueif output is to be unadorned so that emacs and other editors can parse files names, etc.
- See Also:
- .
 
 - 
setErrorPrintStreampublic void setErrorPrintStream(java.io.PrintStream err) Description copied from interface:BuildLoggerSets the output stream to which this logger is to send error messages.- Specified by:
- setErrorPrintStreamin interface- BuildLogger
- Parameters:
- err- The error stream for the logger. Must not be- null.
- See Also:
- .
 
 - 
setProjectpublic void setProject(Project project) Set the project associated with this recorder entry.- Parameters:
- project- the project instance
- Since:
- 1.6.2
 
 - 
getProjectpublic Project getProject() Get the project associated with this recorder entry.- Returns:
- Project
- Since:
- 1.8.0
 
 - 
cleanuppublic void cleanup() - Since:
- 1.6.2
 
 
- 
 
-