Top Description Constructors Methods
org.apache.tools.ant.taskdefs.optional.vss

public Class MSVSSCHECKOUT

extends MSVSS
Class Inheritance
Imports
org.apache.tools.ant.BuildException, org.apache.tools.ant.types.Commandline, .Path
Performs CheckOut commands to Microsoft Visual SourceSafe.

Constructor Summary

AccessConstructor and Description
public
MSVSSCHECKOUT()

Method Summary

Modifier and TypeMethod and Description
protected Commandline

Returns:

The constructed commandline.
buildCmdLine()

Implements abstract org.apache.tools.ant.taskdefs.optional.vss.MSVSS.buildCmdLine.

Builds a command line to execute ss.
public void
setAutoresponse(String
The auto response value.
response)

Autoresponse behaviour.

public void
setDate(String
The date to check-out.
date)

Date to check-out.

public void
setFileTimeStamp(MSVSS.CurrentModUpdated
The file time stamping behaviour.
timestamp)

Date and time stamp given to the local copy.

public void
setGetLocalCopy(boolean
The get local copy behaviour
get)

Retrieve a local copy during a checkout.

public void
setLabel(String
The label to check-out.
label)

Label to check-out.

public void
setLocalpath(Path
The path on disk.
localPath)

Override the project working directory.

public void
setRecursive(boolean
The boolean value for recursive.
recursive)

Check-out files recursively.

public void
setVersion(String
The version to check-out.
version)

Version to check-out.

public void
setWritableFiles(MSVSS.WritableFiles
The writable files behaviour
files)

Action taken when local files are writable.

Inherited from org.apache.tools.ant.taskdefs.optional.vss.MSVSS:
executegetAutoresponsegetCommentgetFileTimeStampgetGetLocalCopygetLabelgetLocalpathgetLogingetOutputgetQuietgetRecursivegetSSCommandgetStylegetUsergetVersiongetVersionDategetVersionDateLabelgetVersionLabelgetVsspathgetWritablegetWritableFilessetFailOnErrorsetInternalAutoResponsesetInternalCommentsetInternalDatesetInternalDateFormatsetInternalFailOnErrorsetInternalFileTimeStampsetInternalFromDatesetInternalFromLabelsetInternalGetLocalCopysetInternalLabelsetInternalLocalPathsetInternalNumDayssetInternalOutputFilenamesetInternalQuietsetInternalRecursivesetInternalStylesetInternalToDatesetInternalToLabelsetInternalUsersetInternalVersionsetInternalWritablesetInternalWritableFilessetLoginsetServerpathsetSsdirsetVsspath

Constructor Detail

MSVSSCHECKOUTback to summary
public MSVSSCHECKOUT()

Method Detail

buildCmdLineback to summary
protected Commandline buildCmdLine()

Implements abstract org.apache.tools.ant.taskdefs.optional.vss.MSVSS.buildCmdLine.

Builds a command line to execute ss.

Returns:Commandline

The constructed commandline.

setAutoresponseback to summary
public void setAutoresponse(String response)

Autoresponse behaviour. Valid options are Y and N.

Parameters
response:String

The auto response value.

setDateback to summary
public void setDate(String date)

Date to check-out.

Parameters
date:String

The date to check-out.

setFileTimeStampback to summary
public void setFileTimeStamp(MSVSS.CurrentModUpdated timestamp)

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

Parameters
timestamp:MSVSS.CurrentModUpdated

The file time stamping behaviour.

setGetLocalCopyback to summary
public void setGetLocalCopy(boolean get)

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

Parameters
get:boolean

The get local copy behaviour

setLabelback to summary
public void setLabel(String label)

Label to check-out.

Parameters
label:String

The label to check-out.

setLocalpathback to summary
public void setLocalpath(Path localPath)

Override the project working directory.

Parameters
localPath:Path

The path on disk.

setRecursiveback to summary
public void setRecursive(boolean recursive)

Check-out files recursively. Defaults to false.

Parameters
recursive:boolean

The boolean value for recursive.

setVersionback to summary
public void setVersion(String version)

Version to check-out.

Parameters
version:String

The version to check-out.

setWritableFilesback to summary
public void setWritableFiles(MSVSS.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:MSVSS.WritableFiles

The writable files behaviour