|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.tools.ant.ProjectComponent | +--org.apache.tools.ant.Task | +--org.apache.tools.ant.taskdefs.optional.vss.MSVSS
A base class for creating tasks for executing commands on Visual SourceSafe.
The class extends the 'exec' task as it operates by executing the ss.exe program supplied with SourceSafe. By default the task expects ss.exe to be in the path, you can override this be specifying the ssdir attribute.
This class provides set and get methods for 'login' and 'vsspath' attributes. It also contains constants for the flags that can be passed to SS.
Nested Class Summary | |
static class |
MSVSS.CurrentModUpdated
Extention of EnumeratedAttribute to hold the values for file time stamp. |
static class |
MSVSS.WritableFiles
Extention of EnumeratedAttribute to hold the values for writable filess. |
Field Summary |
Fields inherited from class org.apache.tools.ant.Task |
description, location, target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
project |
Constructor Summary | |
MSVSS()
|
Method Summary | |
void |
execute()
Executes the task. |
protected java.lang.String |
getAutoresponse()
Gets the auto response string. |
protected java.lang.String |
getComment()
Gets the comment string. |
java.lang.String |
getFileTimeStamp()
Gets the value set for the FileTimeStamp. |
protected java.lang.String |
getGetLocalCopy()
Builds and returns the -G- flag if required. |
protected java.lang.String |
getLabel()
Gets the label string. |
protected java.lang.String |
getLocalpath()
Gets the localpath string. |
protected java.lang.String |
getLogin()
Gets the login string. |
protected java.lang.String |
getOutput()
Gets the output file string. |
protected java.lang.String |
getQuiet()
Gets the quiet string. |
protected java.lang.String |
getRecursive()
Gets the recursive string. |
protected java.lang.String |
getSSCommand()
Gets the sscommand string. |
protected java.lang.String |
getStyle()
Gets the style string. |
protected java.lang.String |
getUser()
Gets the user string. |
protected java.lang.String |
getVersion()
Gets the version string. |
protected java.lang.String |
getVersionDate()
Gets the Version date string. |
protected java.lang.String |
getVersionDateLabel()
Gets the version string. |
protected java.lang.String |
getVersionLabel()
Gets the version string. |
protected java.lang.String |
getVsspath()
Gets the vssserverpath string. |
protected java.lang.String |
getWritable()
Gets the writable string. |
java.lang.String |
getWritableFiles()
Gets the value to determine the behaviour when encountering writable files. |
void |
setFailOnError(boolean failOnError)
Indicates if the build should fail if the Sourcesafe command does. |
protected void |
setInternalAutoResponse(java.lang.String autoResponse)
|
protected void |
setInternalComment(java.lang.String comment)
|
protected void |
setInternalDate(java.lang.String date)
|
protected void |
setInternalDateFormat(java.text.DateFormat dateFormat)
|
protected void |
setInternalFailOnError(boolean failOnError)
|
protected void |
setInternalFileTimeStamp(MSVSS.CurrentModUpdated timestamp)
|
protected void |
setInternalFromDate(java.lang.String fromDate)
|
protected void |
setInternalFromLabel(java.lang.String fromLabel)
|
protected void |
setInternalGetLocalCopy(boolean getLocalCopy)
|
protected void |
setInternalLabel(java.lang.String label)
|
protected void |
setInternalLocalPath(java.lang.String localPath)
|
protected void |
setInternalNumDays(int numDays)
|
protected void |
setInternalOutputFilename(java.lang.String outputFileName)
|
protected void |
setInternalQuiet(boolean quiet)
|
protected void |
setInternalRecursive(boolean recursive)
|
protected void |
setInternalStyle(java.lang.String style)
|
protected void |
setInternalToDate(java.lang.String toDate)
|
protected void |
setInternalToLabel(java.lang.String toLabel)
|
protected void |
setInternalUser(java.lang.String user)
|
protected void |
setInternalVersion(java.lang.String version)
|
protected void |
setInternalWritable(boolean writable)
|
protected void |
setInternalWritableFiles(MSVSS.WritableFiles writableFiles)
|
void |
setLogin(java.lang.String vssLogin)
Login to use when accessing VSS, formatted as "username,password". |
void |
setServerpath(java.lang.String serverPath)
Directory where srssafe.ini resides. |
void |
setSsdir(java.lang.String dir)
Directory where ss.exe resides. |
void |
setVsspath(java.lang.String vssPath)
SourceSafe path which specifies the project/file(s) you wish to perform the action on. |
Methods inherited from class org.apache.tools.ant.Task |
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
getProject, setProject |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public MSVSS()
Method Detail |
public final void setSsdir(java.lang.String dir)
ss.exe
resides.
By default the task expects it to be in the PATH.
dir
- The directory containing ss.exe.public final void setLogin(java.lang.String vssLogin)
You can omit the password if your database is not password protected. If you have a password and omit it, Ant will hang.
vssLogin
- The login string to use.public final void setVsspath(java.lang.String vssPath)
A prefix of 'vss://' will be removed if specified.
vssPath
- The VSS project path.public final void setServerpath(java.lang.String serverPath)
srssafe.ini
resides.
serverPath
- The path to the VSS server.public final void setFailOnError(boolean failOnError)
failOnError
- True if task should fail on any error.public void execute() throws BuildException
execute
in class Task
BuildException
- if the command cannot execute.protected void setInternalComment(java.lang.String comment)
protected void setInternalAutoResponse(java.lang.String autoResponse)
protected void setInternalDate(java.lang.String date)
protected void setInternalDateFormat(java.text.DateFormat dateFormat)
protected void setInternalFailOnError(boolean failOnError)
protected void setInternalFromDate(java.lang.String fromDate)
protected void setInternalFromLabel(java.lang.String fromLabel)
protected void setInternalLabel(java.lang.String label)
protected void setInternalLocalPath(java.lang.String localPath)
protected void setInternalNumDays(int numDays)
protected void setInternalOutputFilename(java.lang.String outputFileName)
protected void setInternalQuiet(boolean quiet)
protected void setInternalRecursive(boolean recursive)
protected void setInternalStyle(java.lang.String style)
protected void setInternalToDate(java.lang.String toDate)
protected void setInternalToLabel(java.lang.String toLabel)
protected void setInternalUser(java.lang.String user)
protected void setInternalVersion(java.lang.String version)
protected void setInternalWritable(boolean writable)
protected void setInternalFileTimeStamp(MSVSS.CurrentModUpdated timestamp)
protected void setInternalWritableFiles(MSVSS.WritableFiles writableFiles)
protected void setInternalGetLocalCopy(boolean getLocalCopy)
protected java.lang.String getSSCommand()
protected java.lang.String getVsspath()
protected java.lang.String getQuiet()
protected java.lang.String getRecursive()
protected java.lang.String getWritable()
protected java.lang.String getLabel()
protected java.lang.String getStyle()
protected java.lang.String getVersionDateLabel()
protected java.lang.String getVersion()
protected java.lang.String getLocalpath()
The localpath is created if it didn't exist.
protected java.lang.String getComment()
protected java.lang.String getAutoresponse()
protected java.lang.String getLogin()
protected java.lang.String getOutput()
protected java.lang.String getUser()
protected java.lang.String getVersionLabel()
protected java.lang.String getVersionDate() throws BuildException
BuildException
protected java.lang.String getGetLocalCopy()
public java.lang.String getFileTimeStamp()
public java.lang.String getWritableFiles()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |