|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.tools.ant.ProjectComponent | +--org.apache.tools.ant.Task | +--org.apache.cactus.ant.ChangeLogTask
A CVS log task that extract information from the execution of the
'cvs log
' command and put them in a generated output XML file.
Note: I have rewritten this task based on the ChangeLog cvslog task from the
Jakarta Alexandria project (initially written by Jeff Martin)
Constructor Summary | |
ChangeLogTask()
|
Method Summary | |
void |
addFileset(org.apache.tools.ant.types.FileSet theSet)
Adds a set of files (nested fileset attribute). |
void |
execute()
Execute task |
void |
setDate(java.lang.String theThresholdDate)
Set the threshold cvs log date. |
void |
setDebug(java.io.File theDebugFile)
Set the debug file. |
void |
setElapsed(java.lang.Long theElapsedDays)
Set the threshold cvs log date by calculating it : "today - elapsed". |
void |
setExecutable(java.lang.String theExecutable)
Sets the CVS client executable to use to perform "cvs log". |
void |
setOutput(java.io.File theOutputFile)
Set the output file for the log. |
void |
setProcessErrorStream(java.io.InputStream theIs)
Set the error stream for reading from CVS log. |
void |
setProcessInputStream(java.io.OutputStream theOs)
Set the input stream for the CVS process. |
void |
setProcessOutputStream(java.io.InputStream theIs)
Set the input stream used to read from CVS log |
void |
setTestURL(java.lang.String theURLString)
Set the test URL to check if internet access is on. |
void |
setUsers(java.io.File theUserConfigFileName)
Set the properties file name containing the matching list of (user id, user display name). |
void |
setWork(java.io.File theWorkDir)
Set the CVS working directory where the cvs log operation will be performed. |
void |
start()
Start reading from the cvs log stream. |
void |
stop()
Stop handling of the streams (i.e. |
Methods inherited from class org.apache.tools.ant.Task |
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, init, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setTaskName |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
getProject, setProject |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ChangeLogTask()
Method Detail |
public void setUsers(java.io.File theUserConfigFileName)
users
attribute is encountered
in the Ant XML build file. This attribute is optional.theUserConfigFileName
- the properties file name relative to the
Ant project base directory (basedir attribute in build file).public void setWork(java.io.File theWorkDir)
work
attribute is encountered
in the Ant XML build file. This attribute is mandatory.theWorkDir
- the CVS working directory relative to the Ant
project base directory (basedir attribute in build file).public void setOutput(java.io.File theOutputFile)
output
attribute is
encountered in the Ant XML build file. This attribute is mandatory.theOutputFile
- the XML output file relative to the Ant project
base directory (i.e. basedir attrifbute in build
file).public void setExecutable(java.lang.String theExecutable)
theExecutable
- the executable to usepublic void setDate(java.lang.String theThresholdDate)
date
attribute is
encountered in the Ant XML build file. This attribute is optional. The
format is "yyyy/MM/dd".theThresholdDate
- the threshold date before which cvs log are
ignored.public void setElapsed(java.lang.Long theElapsedDays)
elapsed
attribute is
encountered in the Ant XML build file. This attribute is optional. The
elasped time must be expressed in days.theElapsedDays
- the elapsed time from now in days. All cvs logs
that are this old will be shown.public void addFileset(org.apache.tools.ant.types.FileSet theSet)
fileset
nested tag is
encountered in the Ant XML build file. This attribute is optional.theSet
- the fileset that contains the list of files for which
cvs logs will be checked.public void setTestURL(java.lang.String theURLString)
testURL
attribute is encountered in the Ant XML build file.
This attribute is optional.theURLString
- the test URL string.public void setDebug(java.io.File theDebugFile) throws java.io.FileNotFoundException, java.io.UnsupportedEncodingException, java.io.IOException
theDebugFile
- the name of the debug file to use.java.io.IOException
- for backward compatibility with JDK 1.2.2 (not
needed for JDK 1.3+)public void execute() throws org.apache.tools.ant.BuildException
execute
in class org.apache.tools.ant.Task
public void setProcessInputStream(java.io.OutputStream theOs) throws java.io.IOException
setProcessInputStream
in interface org.apache.tools.ant.taskdefs.ExecuteStreamHandler
theOs
- the output stream to write to the standard input stream of
the subprocess (i.e. the CVS process)public void setProcessErrorStream(java.io.InputStream theIs) throws java.io.IOException
setProcessErrorStream
in interface org.apache.tools.ant.taskdefs.ExecuteStreamHandler
theIs
- the input stream to read from the error stream from the
subprocess (i.e. the CVS process)public void setProcessOutputStream(java.io.InputStream theIs) throws java.io.IOException
setProcessOutputStream
in interface org.apache.tools.ant.taskdefs.ExecuteStreamHandler
theIs
- the input stream to read from the output stream of the
subprocess (i.e. the CVS process)public void stop()
stop
in interface org.apache.tools.ant.taskdefs.ExecuteStreamHandler
public void start() throws java.io.IOException
start
in interface org.apache.tools.ant.taskdefs.ExecuteStreamHandler
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |