Recorder

Description

A recorder is 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 subsiquent 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.

Parameters

Attribute Description Required
name The name of the file this logger is associated with. yes
action This tells the logger what to do: should it start recording or stop? The first time that the recorder task is called for this logfile, and if this attribute is not provided, then the default for this attribute is "start". If this attribute is not provided on subsiquest calls, then the state remains as previous. [Values = {start|stop}, Default = no state change] no
append Should the recorder append to a file, or create a new one? This is only applicable the first time this task is called for this file. [Vaules = {yes|no}, Default=yes] no
loglevel At what logging level should this recorder instance record to? This is not a once only parameter (like append is) -- you can increase or decrease the logging level as the build process continues. [Vaules= {error|warn|info|verbose|debug}, Default = no change] no

Examples

The following build.xml snippit is an example of how to use the recorder to record just the <javac> task:

    ...
    <compile >
        <recorder file="log.txt" action="start" />
        <javac ...
        <recorder file="log.txt" action="stop" />
    <compile/>
    ...

The following two calls to <recorder> set up two recorders: one to file "records-simple.log" at logging level info (the default) and one to file "ISO.log" using logging level of verbose.

    ...
    <recorder file="records-simple.log" />
    <recorder file="ISO.log" loglevel="verbose" />
    ...

Notes

There is some funtionality that I would like to be able to add in the future. They include things like the following:
Attribute Description Required
messageprefix Whether or not to include the message prefixes (things like the name of the tasks or targets, etc). This has the same effect as the -emacs command line parameter does to the screen output. [yes|no] no
listener A classname of a build listener to use from this point on instead of the default listener. no
includetarget A comma-separated list of targets to automaticly record. If this value is "all", then all targets are recorded. [Default = all] no
excludetarget no
includetask A comma-separated list of task to automaticly record or not. This could be difficult as it could conflict with the includetarget/excludetarget. (e.g.: includetarget="compile" exlcudetask="javac", what should happen?) no
excludetask no
action add greater flexability to the action attribute. Things like close to close the print stream. no


Copyright © 2000,2001 Apache Software Foundation. All rights Reserved.