FileDocCategorySizeDatePackage
MSVSSGET.javaAPI DocApache Ant 1.705281Wed Dec 13 06:16:18 GMT 2006org.apache.tools.ant.taskdefs.optional.vss

MSVSSGET

public class MSVSSGET extends MSVSS
Perform Get commands from Microsoft Visual SourceSafe.
ant.task
name="vssget" category="scm"
ant.attribute.group
name="vdl" description="Only one of version, date or label"

Fields Summary
Constructors Summary
Methods Summary
org.apache.tools.ant.types.CommandlinebuildCmdLine()
Builds a command line to execute ss.

return
The constructed commandline.

        Commandline commandLine = new Commandline();

        // build the command line from what we got the format is
        // ss Get VSS items [-G] [-H] [-I-] [-N] [-O] [-R] [-V] [-W] [-Y] [-?]
        // as specified in the SS.EXE help
        commandLine.setExecutable(getSSCommand());
        commandLine.createArgument().setValue(COMMAND_GET);

        if (getVsspath() == null) {
            throw new BuildException("vsspath attribute must be set!", getLocation());
        }
        commandLine.createArgument().setValue(getVsspath());

        // -GL
        commandLine.createArgument().setValue(getLocalpath());
        // -I- or -I-Y or -I-N
        commandLine.createArgument().setValue(getAutoresponse());
        // -O-
        commandLine.createArgument().setValue(getQuiet());
        // -R
        commandLine.createArgument().setValue(getRecursive());
        // -V
        commandLine.createArgument().setValue(getVersionDateLabel());
        // -W
        commandLine.createArgument().setValue(getWritable());
        // -Y
        commandLine.createArgument().setValue(getLogin());
        // -G
        commandLine.createArgument().setValue(getFileTimeStamp());
        // -GWS or -GWR
        commandLine.createArgument().setValue(getWritableFiles());

        return commandLine;
public voidsetAutoresponse(java.lang.String response)
Autoresponce behaviour. Valid options are Y and N.

param
response The auto response value.

        super.setInternalAutoResponse(response);
public voidsetDate(java.lang.String date)
Date to get.

param
date The date to get.
ant.attribute
group="vdl"

        super.setInternalDate(date);
public voidsetFileTimeStamp(CurrentModUpdated timestamp)
Date and time stamp given to the local copy. Defaults to current.

param
timestamp The file time stamping behaviour.

        super.setInternalFileTimeStamp(timestamp);
public voidsetLabel(java.lang.String label)
Label to get.

param
label The label to get.
ant.attribute
group="vdl"

        super.setInternalLabel(label);
public voidsetLocalpath(org.apache.tools.ant.types.Path localPath)
Override the project working directory.

param
localPath The path on disk.

        super.setInternalLocalPath(localPath.toString());
public final voidsetQuiet(boolean quiet)
Enable quiet mode. Defaults to false.

param
quiet The boolean value for quiet.

        super.setInternalQuiet(quiet);
public final voidsetRecursive(boolean recursive)
Get files recursively. Defaults to false.

param
recursive The boolean value for recursive.

        super.setInternalRecursive(recursive);
public voidsetVersion(java.lang.String version)
Version to get.

param
version The version to get.
ant.attribute
group="vdl"

        super.setInternalVersion(version);
public final voidsetWritable(boolean writable)
Unset the READ-ONLY flag on files retrieved from VSS. Defaults to false.

param
writable The boolean value for writable.

        super.setInternalWritable(writable);
public voidsetWritableFiles(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.

param
files The action to take.

        super.setInternalWritableFiles(files);