net.sourceforge.cruisecontrol
Interface SourceControl

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

Accurev, AlienBrain, AllFusionHarvestCM511, BuildStatus, ClearCase, CMSynergy, Compound, Compound.Entry, ConcurrentVersionsSystem, Darcs, FakeUserSourceControl, ForceOnly, Maven2SnapshotDependency, MavenSnapshotDependency, MKS, P4, PlasticSCM, PVCS, SnapshotCM, SSCM, StarTeam, SVN, UCM, Veto, Vss, VssJournal

public interface SourceControl

extends java.io.Serializable

This interface defines behavior required by ModificationSet.java when gathering information about the changes made to whatever source control tool that you choose. SourceControl implementations commonly define 2 special properties:

• void setProperty(String property): name of property to define if a modification is detected. The property should be added to the set of properties returned by the getProperties() call. Allows the underlying build script to do conditional actions if the files watched by this SourceControl have been modified.
• void setPropertyOnDelete(String property): name of property to define if a deletion is detected. The property should be added to the set of properties returned by the getProperties() call.

Version:

$Id: SourceControl.java 2864 2007-02-18 05:38:22Z jchyip $

Author:

Alden Almagro, Jason Yip

Method Summary

java.util.List	getModifications(java.util.Date lastBuild, java.util.Date now) Get a List of Modifications detailing all the changes between now and the last build
java.util.Map	getProperties() Any properties that have been set in this sourcecontrol.
void	validate()

Method Detail

getModifications

public java.util.List getModifications(java.util.Date lastBuild,
                                       java.util.Date now)

Get a List of Modifications detailing all the changes between now and the last build

Parameters:

lastBuild -

now -

Returns:

List of Modification objects

validate

public void validate()
              throws CruiseControlException

Throws:

CruiseControlException

getProperties

public java.util.Map getProperties()

Any properties that have been set in this sourcecontrol. Will be passed onto the Builder, which may then pass the properties to the underlying build implementation. For example, the Ant builder will define these properties so that the underlying Ant script can use them.