org.apache.tools.ant.taskdefs.cvslib

Class ChangeLogTask


public class ChangeLogTask
extends AbstractCvsTask

Examines the output of cvs log and group related changes together. It produces an XML output representing the list of changes.
 <!-- Root element -->
 <!ELEMENT changelog (entry+)>
 <!-- CVS Entry -->
 <!ELEMENT entry (date,author,file+,msg)>
 <!-- Date of cvs entry -->
 <!ELEMENT date (#PCDATA)>
 <!-- Author of change -->
 <!ELEMENT author (#PCDATA)>
 <!-- List of files affected -->
 <!ELEMENT msg (#PCDATA)>
 <!-- File changed -->
 <!ELEMENT file (name,revision,prevrevision?)>
 <!-- Name of the file -->
 <!ELEMENT name (#PCDATA)>
 <!-- Revision number -->
 <!ELEMENT revision (#PCDATA)>
 <!-- Previous revision number -->
 <!ELEMENT prevrevision (#PCDATA)>
 
Since:
Ant 1.5

Field Summary

Fields inherited from class org.apache.tools.ant.taskdefs.AbstractCvsTask

DEFAULT_COMPRESSION_LEVEL

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

Method Summary

void
addFileset(FileSet fileSet)
Adds a set of files about which cvs logs will be generated.
void
addUser(CvsUser user)
Add a user to list changelog knows about.
void
execute()
Execute task
void
setDaysinpast(int days)
Set the number of days worth of log entries to process.
void
setDestfile(File destfile)
Set the output file for the log.
void
setDir(File dir)
Set the base dir for cvs.
void
setEnd(Date stop)
Set the date at which the changelog should stop.
void
setStart(Date start)
Set the date at which the changelog should start.
void
setUsersfile(File usersFile)
Set a lookup list of user names & addresses

Methods inherited from class org.apache.tools.ant.taskdefs.AbstractCvsTask

addCommandArgument, addCommandArgument, addConfiguredCommandline, addConfiguredCommandline, configureCommandline, execute, getCommand, getCvsRoot, getCvsRsh, getDest, getErrorStream, getExecuteStreamHandler, getOutputStream, getPackage, getPassFile, getPort, getTag, removeCommandline, runCommand, setAppend, setCommand, setCompression, setCompressionLevel, setCvsRoot, setCvsRsh, setDate, setDest, setError, setErrorStream, setExecuteStreamHandler, setFailOnError, setNoexec, setOutput, setOutputStream, setPackage, setPassfile, setPort, setQuiet, setReallyquiet, setTag

Methods inherited from class org.apache.tools.ant.Task

execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Method Details

addFileset

public void addFileset(FileSet fileSet)
Adds a set of files about which cvs logs will be generated.
Parameters:
fileSet - a set of files about which cvs logs will be generated.

addUser

public void addUser(CvsUser user)
Add a user to list changelog knows about.
Parameters:
user - the user

execute

public void execute()
            throws BuildException
Execute task
Overrides:
execute in interface AbstractCvsTask
Throws:
BuildException - if something goes wrong executing the cvs command

setDaysinpast

public void setDaysinpast(int days)
Set the number of days worth of log entries to process.
Parameters:
days - the number of days of log to process.

setDestfile

public void setDestfile(File destfile)
Set the output file for the log.
Parameters:
destfile - The new destfile value

setDir

public void setDir(File dir)
Set the base dir for cvs.
Parameters:
dir - The new dir value

setEnd

public void setEnd(Date stop)
Set the date at which the changelog should stop.
Parameters:
stop - The date at which the changelog should stop.

setStart

public void setStart(Date start)
Set the date at which the changelog should start.
Parameters:
start - The date at which the changelog should start.

setUsersfile

public void setUsersfile(File usersFile)
Set a lookup list of user names & addresses
Parameters:
usersFile - The file containing the users info.

Copyright B) 2000-2006 Apache Software Foundation. All Rights Reserved.