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

public Class MSVSSGET

extends MSVSS
Class Inheritance
Imports
org.apache.tools.ant.BuildException, org.apache.tools.ant.types.Commandline, .Path
Perform Get commands from Microsoft Visual SourceSafe.

Constructor Summary

AccessConstructor and Description
public
MSVSSGET()

Method Summary

Modifier and TypeMethod and Description
pack-priv 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 get.
date)

Date to get.

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

Date and time stamp given to the local copy.

public void
setLabel(String
The label to get.
label)

Label to get.

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

Override the project working directory.

public final void
setQuiet(boolean
The boolean value for quiet.
quiet)

Enable quiet mode.

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

Get files recursively.

public void
setVersion(String
The version to get.
version)

Version to get.

public final void
setWritable(boolean
The boolean value for writable.
writable)

Unset the READ-ONLY flag on files retrieved from VSS.

public void
setWritableFiles(MSVSS.WritableFiles
The action to take.
files)

Action taken when local files are writable.

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

Constructor Detail

MSVSSGETback to summary
public MSVSSGET()

Method Detail

buildCmdLineback to summary
pack-priv 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 get.

Parameters
date:String

The date to get.

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.

setLabelback to summary
public void setLabel(String label)

Label to get.

Parameters
label:String

The label to get.

setLocalpathback to summary
public void setLocalpath(Path localPath)

Override the project working directory.

Parameters
localPath:Path

The path on disk.

setQuietback to summary
public final void setQuiet(boolean quiet)

Enable quiet mode. Defaults to false.

Parameters
quiet:boolean

The boolean value for quiet.

setRecursiveback to summary
public final void setRecursive(boolean recursive)

Get files recursively. Defaults to false.

Parameters
recursive:boolean

The boolean value for recursive.

setVersionback to summary
public void setVersion(String version)

Version to get.

Parameters
version:String

The version to get.

setWritableback to summary
public final void setWritable(boolean writable)

Unset the READ-ONLY flag on files retrieved from VSS. Defaults to false.

Parameters
writable:boolean

The boolean value for writable.

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 action to take.