org.apache.tools.ant.taskdefs.optional.vss

Class MSVSSCHECKOUT

public class MSVSSCHECKOUT extends MSVSS

Performs CheckOut commands to Microsoft Visual SourceSafe.

UNKNOWN: name="vsscheckout" category="scm" name="vdl" description="Only one of version, date or label"

Method Summary
protected Commandline	buildCmdLine() Builds a command line to execute ss.
void	setAutoresponse(String response) Autoresponce behaviour.
void	setDate(String date) Date to check-out.
void	setFileTimeStamp(CurrentModUpdated timestamp) Date and time stamp given to the local copy.
void	setGetLocalCopy(boolean get) Retrieve a local copy during a checkout.
void	setLabel(String label) Label to check-out.
void	setLocalpath(Path localPath) Override the project working directory.
void	setRecursive(boolean recursive) Check-out files recursively.
void	setVersion(String version) Version to check-out.
void	setWritableFiles(WritableFiles files) Action taken when local files are writable.

Method Detail

buildCmdLine

protected Commandline buildCmdLine()

Builds a command line to execute ss.

Returns: The constructed commandline.

setAutoresponse

public void setAutoresponse(String response)

Autoresponce behaviour. Valid options are Y and N.

Parameters: response The auto response value.

setDate

public void setDate(String date)

Date to check-out.

Parameters: date The date to check-out.

UNKNOWN: group="vdl"

setFileTimeStamp

public void setFileTimeStamp(CurrentModUpdated timestamp)

Date and time stamp given to the local copy. Defaults to current.

Parameters: timestamp The file time stamping behaviour.

setGetLocalCopy

public void setGetLocalCopy(boolean get)

Retrieve a local copy during a checkout. Defaults to true.

Parameters: get The get local copy behaviour

setLabel

public void setLabel(String label)

Label to check-out.

Parameters: label The label to check-out.

UNKNOWN: group="vdl"

setLocalpath

public void setLocalpath(Path localPath)

Override the project working directory.

Parameters: localPath The path on disk.

setRecursive

public void setRecursive(boolean recursive)

Check-out files recursively. Defaults to false.

Parameters: recursive The boolean value for recursive.

setVersion

public void setVersion(String version)

Version to check-out.

Parameters: version The version to check-out.

UNKNOWN: group="vdl"

setWritableFiles

public void setWritableFiles(WritableFiles files)

Action taken when local files are writable. Defaults to fail.

Due to ss.exe returning with an exit code of '100' for both errors and when a file has been skipped, failonerror is set to false when using the skip option.

Parameters: files The writable files behaviour