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

java.lang.Object
  |
  +--org.apache.tools.ant.Task
        |
        +--org.apache.tools.ant.taskdefs.optional.vss.MSVSS
              |
              +--org.apache.tools.ant.taskdefs.optional.vss.MSVSSGET

public class MSVSSGET
extends MSVSS

Task to perform GET commands to Microsoft Visual Source Safe.

The following attributes are interpretted:
Attribute Values Required
login username,password No
vsspath SourceSafe path Yes
localpath Override the working directory and get to the specified path No
writable true or false No
recursive true or false No
version a version number to get No
date a date stamp to get at No
label a label to get for No

Note that only one of version, date or label should be specified

Author:
Craig Cottingham, Andrew Everitt

Fields inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
COMMAND_CHECKOUT, COMMAND_GET, COMMAND_HISTORY, COMMAND_LABEL, FLAG_AUTORESPONSE_DEF, FLAG_AUTORESPONSE_NO, FLAG_AUTORESPONSE_YES, FLAG_LOGIN, FLAG_OVERRIDE_WORKING_DIR, FLAG_RECURSION, FLAG_VERSION, FLAG_VERSION_DATE, FLAG_VERSION_LABEL, FLAG_WRITABLE, PROJECT_PREFIX, VALUE_NO, VALUE_YES
 
Fields inherited from class org.apache.tools.ant.Task
description, location, project, target, taskName, taskType, wrapper
 
Constructor Summary
MSVSSGET()
           
 
Method Summary
 void execute()
          Executes the task.
 void getAutoresponse(Commandline cmd)
          Checks the value set for the autoResponse.
 void getLocalpathCommand(Commandline cmd)
          Builds and returns the -GL flag command if required
 void getRecursiveCommand(Commandline cmd)
           
 void getVersionCommand(Commandline cmd)
          Simple order of priority.
 void getWritableCommand(Commandline cmd)
           
 void setAutoresponse(java.lang.String response)
           
 void setDate(java.lang.String date)
          Set the stored date string
 void setLabel(java.lang.String label)
          Set the labeled version to operate on in SourceSafe
 void setLocalpath(Path localPath)
          Set the local path.
 void setRecursive(boolean recursive)
          Set behaviour recursive or non-recursive
 void setVersion(java.lang.String version)
          Set the stored version string
 void setWritable(boolean argWritable)
          Set behaviour, used in get command to make files that are 'got' writable
 
Methods inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
getLoginCommand, getSSCommand, getVsspath, run, setLogin, setSsdir, setVsspath
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getProject, getRuntimeConfigurableWrapper, getTaskName, init, log, log, maybeConfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MSVSSGET

public MSVSSGET()
Method Detail

execute

public void execute()
             throws BuildException
Executes the task.

Builds a command line to execute ss and then calls Exec's run method to execute the command line.

Overrides:
execute in class Task
Following copied from class: org.apache.tools.ant.Task
Throws:
BuildException - if someting goes wrong with the build

setLocalpath

public void setLocalpath(Path localPath)
Set the local path.

getLocalpathCommand

public void getLocalpathCommand(Commandline cmd)
Builds and returns the -GL flag command if required

The localpath is created if it didn't exist


setRecursive

public void setRecursive(boolean recursive)
Set behaviour recursive or non-recursive

getRecursiveCommand

public void getRecursiveCommand(Commandline cmd)
Returns:
the 'recursive' command if the attribute was 'true', otherwise an empty string

setWritable

public final void setWritable(boolean argWritable)
Set behaviour, used in get command to make files that are 'got' writable

getWritableCommand

public void getWritableCommand(Commandline cmd)
Returns:
the 'make writable' command if the attribute was 'true', otherwise an empty string

setVersion

public void setVersion(java.lang.String version)
Set the stored version string

Note we assume that if the supplied string has the value "null" that something went wrong and that the string value got populated from a null object. This happens if a ant variable is used e.g. version="${ver_server}" when ver_server has not been defined to ant!


setDate

public void setDate(java.lang.String date)
Set the stored date string

Note we assume that if the supplied string has the value "null" that something went wrong and that the string value got populated from a null object. This happens if a ant variable is used e.g. date="${date}" when date has not been defined to ant!


setLabel

public void setLabel(java.lang.String label)
Set the labeled version to operate on in SourceSafe

Note we assume that if the supplied string has the value "null" that something went wrong and that the string value got populated from a null object. This happens if a ant variable is used e.g. label="${label_server}" when label_server has not been defined to ant!


getVersionCommand

public void getVersionCommand(Commandline cmd)
Simple order of priority. Returns the first specified of version, date, label If none of these was specified returns ""

setAutoresponse

public void setAutoresponse(java.lang.String response)

getAutoresponse

public void getAutoresponse(Commandline cmd)
Checks the value set for the autoResponse. if it equals "Y" then we return -I-Y if it equals "N" then we return -I-N otherwise we return -I


Copyright ? 2000 Apache Software Foundation. All Rights Reserved.