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

public class Recorder
extends Task

This task is the manager for RecorderEntry's. It is this class that holds all entries, modifies them every time the task is called, and addes them to the build listener process.

Version:
0.5
Author:
J D Glanville
See Also:
RecorderEntry

Inner Class Summary
static class Recorder.ActionChoices
          A list of possible values for the setAction() method.
static class Recorder.VerbosityLevelChoices
          A list of possible values for the setLoglevel() method.
 
Fields inherited from class org.apache.tools.ant.Task
description, location, target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
project
 
Constructor Summary
Recorder()
           
 
Method Summary
 void execute()
          The main execution.
protected  RecorderEntry getRecorder(java.lang.String name, Project proj)
          Gets the recorder that's associated with the passed in name.
 void setAction(Recorder.ActionChoices action)
          Sets the action for the associated recorder entry.
 void setAppend(boolean append)
          Whether or not the logger should append to a previous file.
 void setLoglevel(Recorder.VerbosityLevelChoices level)
          Sets the level to which this recorder entry should log to.
 void setName(java.lang.String fname)
          Sets the name of the file to log to, and the name of the recorder entry.
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
getProject, setProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Recorder

public Recorder()
Method Detail

setName

public void setName(java.lang.String fname)
Sets the name of the file to log to, and the name of the recorder entry.
Parameters:
fname - File name of logfile.

setAction

public void setAction(Recorder.ActionChoices action)
Sets the action for the associated recorder entry.
Parameters:
action - The action for the entry to take: start or stop.

setAppend

public void setAppend(boolean append)
Whether or not the logger should append to a previous file.

setLoglevel

public void setLoglevel(Recorder.VerbosityLevelChoices level)
Sets the level to which this recorder entry should log to.
See Also:
Recorder.VerbosityLevelChoices

execute

public void execute()
             throws BuildException
The main execution.
Overrides:
execute in class Task
Following copied from class: org.apache.tools.ant.Task
Throws:
BuildException - if someting goes wrong with the build

getRecorder

protected RecorderEntry getRecorder(java.lang.String name,
                                    Project proj)
                             throws BuildException
Gets the recorder that's associated with the passed in name. If the recorder doesn't exist, then a new one is created.


Copyright © 1999-2002 Apache Software Foundation. All Rights Reserved.