net.sourceforge.cruisecontrol.sourcecontrols
Class Mercurial

java.lang.Object
  net.sourceforge.cruisecontrol.sourcecontrols.Mercurial

All Implemented Interfaces:

java.io.Serializable, SourceControl

public class Mercurial

extends java.lang.Object

implements SourceControl

This class implements the SourceControl methods for a Mercurial repository.

Author:

Jerome Lacoste

See Also:

Mercurial web site, Serialized Form

Constructor Summary

Mercurial()

Method Summary

java.util.List	getModifications(java.util.Date lastBuildDate, java.util.Date now) Returns a list of modifications detailing all the changes between the last build and the latest revision in the repository.
java.util.Map	getProperties() Any properties that have been set in this sourcecontrol.
void	setLocalWorkingCopy(java.lang.String localWorkingCopy) Sets the local working copy to use when making calls to mercurial.
void	setProperty(java.lang.String property)
void	setPropertyOnDelete(java.lang.String propertyOnDelete)
void	validate() This method validates that at least the repository location or the local working copy location has been specified.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Mercurial

public Mercurial()

Method Detail

getProperties

public java.util.Map getProperties()

Description copied from interface: SourceControl

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.

Specified by:

getProperties in interface SourceControl

setProperty

public void setProperty(java.lang.String property)

setPropertyOnDelete

public void setPropertyOnDelete(java.lang.String propertyOnDelete)

setLocalWorkingCopy

public void setLocalWorkingCopy(java.lang.String localWorkingCopy)

Sets the local working copy to use when making calls to mercurial.

Parameters:

localWorkingCopy - String indicating the relative or absolute path to the local working copy of the mercurial repository of which to find the log history.

validate

public void validate()
              throws CruiseControlException

This method validates that at least the repository location or the local working copy location has been specified.

Specified by:

validate in interface SourceControl

Throws:

CruiseControlException - Thrown when the repository location and the local working copy location are both null

getModifications

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

Returns a list of modifications detailing all the changes between the last build and the latest revision in the repository.

Specified by:

getModifications in interface SourceControl

Parameters:

lastBuildDate -

now -

Returns:

the list of modifications, or an empty list if we failed to retrieve the changes.