Package org.apache.tools.ant.taskdefs
Class Recorder
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.Recorder
- All Implemented Interfaces:
- Cloneable,- EventListener,- BuildListener,- SubBuildListener
Adds a listener to the current build process that records the
 output to a file.
 
Several recorders can exist at the same time. Each recorder is associated with a file. The filename is used as a unique identifier for the recorders. The first call to the recorder task with an unused filename will create a recorder (using the parameters provided) and add it to the listeners of the build. All subsequent calls to the recorder task using this filename will modify that recorders state (recording or not) or other properties (like logging level).
Some technical issues: the file's print stream is flushed for "finished" events (buildFinished, targetFinished and taskFinished), and is closed on a buildFinished event.
- Since:
- Ant 1.4
- Version:
- 0.5
- See Also:
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classA list of possible values for thesetAction()method.static classA list of possible values for thesetLoglevel()method.
- 
Field SummaryFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidbuildFinished(BuildEvent event) Cleans recorder registry.voidbuildStarted(BuildEvent event) Empty implementation required by SubBuildListener interface.voidexecute()The main execution.protected RecorderEntrygetRecorder(String name, Project proj) Gets the recorder that's associated with the passed in name.voidinit()Overridden so we can add the task as build listener.voidmessageLogged(BuildEvent event) Empty implementation required by SubBuildListener interface.voidsetAction(Recorder.ActionChoices action) Sets the action for the associated recorder entry.voidsetAppend(boolean append) Whether or not the logger should append to a previous file.voidsetEmacsMode(boolean emacsMode) Set emacs mode.voidSets the level to which this recorder entry should log to.voidsetLogLevel(LogLevel level) Sets the level to which this recorder entry should log to.voidSets the name of the file to log to, and the name of the recorder entry.voidsubBuildFinished(BuildEvent event) Cleans recorder registry, if this is the subbuild the task has been created in.voidsubBuildStarted(BuildEvent event) Empty implementation required by SubBuildListener interface.voidtargetFinished(BuildEvent event) Empty implementation required by SubBuildListener interface.voidtargetStarted(BuildEvent event) Empty implementation required by SubBuildListener interface.voidtaskFinished(BuildEvent event) Empty implementation required by SubBuildListener interface.voidtaskStarted(BuildEvent event) Empty implementation required by SubBuildListener interface.Methods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
- 
Constructor Details- 
Recorderpublic Recorder()
 
- 
- 
Method Details- 
initpublic void init()Overridden so we can add the task as build listener.
- 
setNameSets the name of the file to log to, and the name of the recorder entry.- Parameters:
- fname- File name of logfile.
 
- 
setActionSets the action for the associated recorder entry.- Parameters:
- action- The action for the entry to take: start or stop.
 
- 
setAppendpublic void setAppend(boolean append) Whether or not the logger should append to a previous file.- Parameters:
- append- if true, append to a previous file.
 
- 
setEmacsModepublic void setEmacsMode(boolean emacsMode) Set emacs mode.- Parameters:
- emacsMode- if true use emacs mode
 
- 
setLoglevelSets the level to which this recorder entry should log to.- Parameters:
- level- the level to set.
- See Also:
 
- 
setLogLevelSets the level to which this recorder entry should log to.- Parameters:
- level- the level to set.
- Since:
- Ant 1.10.14
 
- 
executeThe main execution.- Overrides:
- executein class- Task
- Throws:
- BuildException- on error
 
- 
getRecorderGets the recorder that's associated with the passed in name. If the recorder doesn't exist, then a new one is created.- Parameters:
- name- the name of the recorder
- proj- the current project
- Returns:
- a recorder
- Throws:
- BuildException- on error
 
- 
buildStartedEmpty implementation required by SubBuildListener interface.- Specified by:
- buildStartedin interface- BuildListener
- Parameters:
- event- ignored.
- Since:
- Ant 1.7
 
- 
subBuildStartedEmpty implementation required by SubBuildListener interface.- Specified by:
- subBuildStartedin interface- SubBuildListener
- Parameters:
- event- ignored.
- Since:
- Ant 1.7
 
- 
targetStartedEmpty implementation required by SubBuildListener interface.- Specified by:
- targetStartedin interface- BuildListener
- Parameters:
- event- ignored.
- Since:
- Ant 1.7
- See Also:
 
- 
targetFinishedEmpty implementation required by SubBuildListener interface.- Specified by:
- targetFinishedin interface- BuildListener
- Parameters:
- event- ignored.
- Since:
- Ant 1.7
- See Also:
 
- 
taskStartedEmpty implementation required by SubBuildListener interface.- Specified by:
- taskStartedin interface- BuildListener
- Parameters:
- event- ignored.
- Since:
- Ant 1.7
- See Also:
 
- 
taskFinishedEmpty implementation required by SubBuildListener interface.- Specified by:
- taskFinishedin interface- BuildListener
- Parameters:
- event- ignored.
- Since:
- Ant 1.7
- See Also:
 
- 
messageLoggedEmpty implementation required by SubBuildListener interface.- Specified by:
- messageLoggedin interface- BuildListener
- Parameters:
- event- ignored.
- Since:
- Ant 1.7
- See Also:
 
- 
buildFinishedCleans recorder registry.- Specified by:
- buildFinishedin interface- BuildListener
- Parameters:
- event- ignored.
- Since:
- Ant 1.7
- See Also:
 
- 
subBuildFinishedCleans recorder registry, if this is the subbuild the task has been created in.- Specified by:
- subBuildFinishedin interface- SubBuildListener
- Parameters:
- event- ignored.
- Since:
- Ant 1.7
- See Also:
 
 
-