ChangeLogTask (Apache Ant API)
Keywords: org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask class

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.tools.ant.taskdefs.cvslib
Class ChangeLogTask

    java.lang.Object
      org.apache.tools.ant.ProjectComponent
          org.apache.tools.ant.Task
              org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask

public class ChangeLogTask
extends Task

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
Version:
  $Revision: 1.14.2.6 $ $Date: 2003/02/21 00:19:22 $
Author:
  Jeff Martin, Peter Donald

Field Summary

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
`ChangeLogTask()`

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(java.io.File destfile)` Set the output file for the log.
`void` | `setDir(java.io.File dir)` Set the base dir for cvs.
`void` | `setEnd(java.util.Date stop)` Set the date at which the changelog should stop.
`void` | `setStart(java.util.Date start)` Set the date at which the changelog should start.
`void` | `setUsersfile(java.io.File usersFile)` Set a lookup list of user names & addresses

Methods inherited from class org.apache.tools.ant.Task
`getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorFlush, handleErrorOutput, handleFlush, handleOutput, init, isInvalid, 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

### ChangeLogTask

    public ChangeLogTask()

Method Detail

### setDir

    public void setDir(java.io.File dir)

  Set the base dir for cvs.

  Parameters:
    `dir` - The new dir value

### setDestfile

    public void setDestfile(java.io.File destfile)

  Set the output file for the log.

  Parameters:
    `destfile` - The new destfile value

### setUsersfile

    public void setUsersfile(java.io.File usersFile)

  Set a lookup list of user names & addresses

  Parameters:
    `usersFile` - The file containing the users info.

### addUser

    public void addUser(CvsUser user)

  Add a user to list changelog knows about.

  Parameters:
    `user` - the user

### setStart

    public void setStart(java.util.Date start)

  Set the date at which the changelog should start.

  Parameters:
    `start` - The date at which the changelog should start.

### setEnd

    public void setEnd(java.util.Date stop)

  Set the date at which the changelog should stop.

  Parameters:
    `stop` - The date at which the changelog should stop.

### 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.

### 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.

### execute

    public void execute()
                 throws BuildException

  Execute task

  Overrides:
    `execute` in class `Task`
  Throws:
    `BuildException` - if something goes wrong executing the cvs command

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2003 Apache Software Foundation. All Rights Reserved.