Class MSVSSCHECKOUT
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.optional.vss.MSVSS
org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKOUT
- All Implemented Interfaces:
Cloneable,MSVSSConstants
Performs CheckOut commands to Microsoft Visual SourceSafe.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
MSVSS.CurrentModUpdated, MSVSS.WritableFiles -
Field Summary
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, projectFields inherited from interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants
COMMAND_ADD, COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_CP, COMMAND_CREATE, COMMAND_GET, COMMAND_HISTORY, COMMAND_LABEL, FLAG_AUTORESPONSE_DEF, FLAG_AUTORESPONSE_NO, FLAG_AUTORESPONSE_YES, FLAG_BRIEF, FLAG_CODEDIFF, FLAG_COMMENT, FLAG_FILETIME_DEF, FLAG_FILETIME_MODIFIED, FLAG_FILETIME_UPDATED, FLAG_LABEL, FLAG_LOGIN, FLAG_NO_FILE, FLAG_NO_GET, FLAG_OUTPUT, FLAG_OVERRIDE_WORKING_DIR, FLAG_QUIET, FLAG_RECURSION, FLAG_REPLACE_WRITABLE, FLAG_SKIP_WRITABLE, FLAG_USER, FLAG_VERSION, FLAG_VERSION_DATE, FLAG_VERSION_LABEL, FLAG_WRITABLE, PROJECT_PREFIX, SS_EXE, STYLE_BRIEF, STYLE_CODEDIFF, STYLE_DEFAULT, STYLE_NOFILE, TIME_CURRENT, TIME_MODIFIED, TIME_UPDATED, VALUE_FROMDATE, VALUE_FROMLABEL, VALUE_NO, VALUE_YES, WRITABLE_FAIL, WRITABLE_REPLACE, WRITABLE_SKIP -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected CommandlineBuilds a command line to execute ss.voidsetAutoresponse(String response) Autoresponse behaviour.voidDate to check-out.voidsetFileTimeStamp(MSVSS.CurrentModUpdated timestamp) Date and time stamp given to the local copy.voidsetGetLocalCopy(boolean get) Retrieve a local copy during a checkout.voidLabel to check-out.voidsetLocalpath(Path localPath) Override the project working directory.voidsetRecursive(boolean recursive) Check-out files recursively.voidsetVersion(String version) Version to check-out.voidAction taken when local files are writable.Methods inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
execute, getAutoresponse, getComment, getFileTimeStamp, getGetLocalCopy, getLabel, getLocalpath, getLogin, getOutput, getQuiet, getRecursive, getSSCommand, getStyle, getUser, getVersion, getVersionDate, getVersionDateLabel, getVersionLabel, getVsspath, getWritable, getWritableFiles, setFailOnError, setInternalAutoResponse, setInternalComment, setInternalDate, setInternalDateFormat, setInternalFailOnError, setInternalFileTimeStamp, setInternalFromDate, setInternalFromLabel, setInternalGetLocalCopy, setInternalLabel, setInternalLocalPath, setInternalNumDays, setInternalOutputFilename, setInternalQuiet, setInternalRecursive, setInternalStyle, setInternalToDate, setInternalToLabel, setInternalUser, setInternalVersion, setInternalWritable, setInternalWritableFiles, setLogin, setServerpath, setSsdir, setVsspathMethods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Constructor Details
-
MSVSSCHECKOUT
public MSVSSCHECKOUT()
-
-
Method Details
-
buildCmdLine
Builds a command line to execute ss.- Returns:
- The constructed commandline.
-
setLocalpath
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
Version to check-out.- Parameters:
version- The version to check-out.
-
setDate
Date to check-out.- Parameters:
date- The date to check-out.
-
setLabel
Label to check-out.- Parameters:
label- The label to check-out.
-
setAutoresponse
Autoresponse behaviour. Valid options are Y and N.- Parameters:
response- The auto response value.
-
setFileTimeStamp
Date and time stamp given to the local copy. Defaults tocurrent.- Parameters:
timestamp- The file time stamping behaviour.
-
setWritableFiles
Action taken when local files are writable. Defaults tofail.Due to ss.exe returning with an exit code of '100' for both errors and when a file has been skipped,
failonerroris set to false when using theskipoption.- Parameters:
files- The writable files behaviour
-
setGetLocalCopy
public void setGetLocalCopy(boolean get) Retrieve a local copy during a checkout. Defaults to true.- Parameters:
get- The get local copy behaviour
-