MSVSSGET Apache Ant 1.7.1)

Methods

Hide/Show inherited methods

publicfinal void bindToOwner (Task owner) [Inherited From Task]

Bind a task to another; use this when configuring a newly created task to do work on behalf of another.

pack-private Commandline buildCmdLine () [Specified in MSVSS]

Builds a command line to execute ss.

public java.lang.Object clone () throws java.lang.CloneNotSupportedException [Inherited From ProjectComponent]

public void execute () throws BuildException [Inherited From MSVSS]

Executes the task.

protected java.lang.String getAutoresponse () [Inherited From MSVSS]

Gets the auto response string.

protected java.lang.String getComment () [Inherited From MSVSS]

Gets the comment string.

public java.lang.String getDescription () [Inherited From ProjectComponent]

Returns the description of the current action.

Returns the description of the current action.
Returns: the description of the current action, or null if no description is available.

public java.lang.String getFileTimeStamp () [Inherited From MSVSS]

Gets the value set for the FileTimeStamp.

protected java.lang.String getGetLocalCopy () [Inherited From MSVSS]

Builds and returns the -G- flag if required.

protected java.lang.String getLabel () [Inherited From MSVSS]

Gets the label string.

protected java.lang.String getLocalpath () [Inherited From MSVSS]

Gets the localpath string.

public Location getLocation () [Inherited From ProjectComponent]

Returns the file/location where this task was defined.

Returns the file/location where this task was defined.
Returns: the file/location where this task was defined. Should not return null. Location.UNKNOWN_LOCATION is used for unknown locations.
See Also: Location.UNKNOWN_LOCATION,

protected java.lang.String getLogin () [Inherited From MSVSS]

Gets the login string.

protected java.lang.String getOutput () [Inherited From MSVSS]

Gets the output file string.

public Target getOwningTarget () [Inherited From Task]

Returns the container target of this task.

Returns the container target of this task.
Returns: The target containing this task, or null if this task is a top-level task.

public Project getProject () [Inherited From ProjectComponent]

Returns the project to which this component belongs.

protected java.lang.String getQuiet () [Inherited From MSVSS]

Gets the quiet string.

protected java.lang.String getRecursive () [Inherited From MSVSS]

Gets the recursive string.

public RuntimeConfigurable getRuntimeConfigurableWrapper () [Inherited From Task]

Returns the wrapper used for runtime configuration.

protected java.lang.String getSSCommand () [Inherited From MSVSS]

Gets the sscommand string.

protected java.lang.String getStyle () [Inherited From MSVSS]

Gets the style string.

public java.lang.String getTaskName () [Inherited From Task]

Returns the name to use in logging messages.

public java.lang.String getTaskType () [Inherited From Task]

Return the type of task.

protected java.lang.String getUser () [Inherited From MSVSS]

Gets the user string.

protected java.lang.String getVersion () [Inherited From MSVSS]

Gets the version string.

protected java.lang.String getVersionDate () throws BuildException [Inherited From MSVSS]

Gets the Version date string.

protected java.lang.String getVersionDateLabel () [Inherited From MSVSS]

Gets the version string.

protected java.lang.String getVersionLabel () [Inherited From MSVSS]

Gets the version string.

protected java.lang.String getVsspath () [Inherited From MSVSS]

Gets the vssserverpath string.

protected RuntimeConfigurable getWrapper () [Inherited From Task]

Return the runtime configurable structure for this task.

protected java.lang.String getWritable () [Inherited From MSVSS]

Gets the writable string.

public java.lang.String getWritableFiles () [Inherited From MSVSS]

Gets the value to determine the behaviour when encountering writable files.

protected void handleErrorFlush (java.lang.String output) [Inherited From Task]

Handles an error line by logging it with the WARN priority.

Handles an error line by logging it with the WARN priority.
Parameters:
- output - The error output to log. Should not be null.
Since: Ant 1.5.2

protected void handleErrorOutput (java.lang.String output) [Inherited From Task]

Handles an error output by logging it with the WARN priority.

Handles an error output by logging it with the WARN priority.
Parameters:
- output - The error output to log. Should not be null.

protected void handleFlush (java.lang.String output) [Inherited From Task]

Handles output by logging it with the INFO priority.

Handles output by logging it with the INFO priority.
Parameters:
- output - The output to log. Should not be null.
Since: Ant 1.5.2

protected int handleInput (byte[] buffer, int offset, int length) throws java.io.IOException [Inherited From Task]

Handle an input request by this task.

protected void handleOutput (java.lang.String output) [Inherited From Task]

Handles output by logging it with the INFO priority.

Handles output by logging it with the INFO priority.
Parameters:
- output - The output to log. Should not be null.

public void init () throws BuildException [Inherited From Task]

Called by the project to let the task initialize properly.

protectedfinal boolean isInvalid () [Inherited From Task]

Has this task been marked invalid?

public void log (java.lang.String msg) [Inherited From Task]

Logs a message with the default (INFO) priority.

Logs a message with the default (INFO) priority.
Parameters:
- msg - The message to be logged. Should not be null.

public void log (java.lang.String msg, int msgLevel) [Inherited From Task]

Logs a message with the given priority.

Logs a message with the given priority. This delegates
the actual logging to the project.
Parameters:
- msg - The message to be logged. Should not be null.
- msgLevel - The message priority at which this message is to be logged.

public void log (java.lang.String msg, java.lang.Throwable t, int msgLevel) [Inherited From Task]

Logs a message with the given priority.

Logs a message with the given priority. This delegates
the actual logging to the project.
Parameters:
- msg - The message to be logged. Should not be null.
- t - The exception to be logged. May be null.
- msgLevel - The message priority at which this message is to be logged.
Since: 1.7

public void log (java.lang.Throwable t, int msgLevel) [Inherited From Task]

Logs a message with the given priority.

Logs a message with the given priority. This delegates
the actual logging to the project.
Parameters:
- t - The exception to be logged. Should not be null.
- msgLevel - The message priority at which this message is to be logged.
Since: 1.7

public void maybeConfigure () throws BuildException [Inherited From Task]

Configures this task - if it hasn't been done already.

publicfinal void perform () [Inherited From Task]

Performs this task if it's still valid, or gets a replacement version and performs that otherwise.

public void reconfigure () [Inherited From Task]

Force the task to be reconfigured from its RuntimeConfigurable.

public void setAutoresponse (java.lang.String response)

Autoresponce behaviour.

public void setDate (java.lang.String date)

Date to get.

public void setDescription (java.lang.String desc) [Inherited From ProjectComponent]

Sets a description of the current action.

Sets a description of the current action. This may be used for logging
purposes.
Parameters:
- desc - Description of the current action. May be null, indicating that no description is available.

publicfinal void setFailOnError (boolean failOnError) [Inherited From MSVSS]

Indicates if the build should fail if the Sourcesafe command does.

public void setFileTimeStamp (CurrentModUpdated timestamp)

Date and time stamp given to the local copy.

Date and time stamp given to the local copy. Defaults to current.
Parameters:
- timestamp - The file time stamping behaviour.

protected void setInternalAutoResponse (java.lang.String autoResponse) [Inherited From MSVSS]

Set the auto response attribute.

protected void setInternalComment (java.lang.String comment) [Inherited From MSVSS]

Set the internal comment attribute.

protected void setInternalDate (java.lang.String date) [Inherited From MSVSS]

Set the date attribute.

protected void setInternalDateFormat (java.text.DateFormat dateFormat) [Inherited From MSVSS]

Set the date format attribute.

protected void setInternalFailOnError (boolean failOnError) [Inherited From MSVSS]

Set the failOnError attribute.

protected void setInternalFileTimeStamp (CurrentModUpdated timestamp) [Inherited From MSVSS]

Set the timestamp attribute.

protected void setInternalFromDate (java.lang.String fromDate) [Inherited From MSVSS]

Set the from date attribute.

protected void setInternalFromLabel (java.lang.String fromLabel) [Inherited From MSVSS]

Set the from label attribute.

protected void setInternalGetLocalCopy (boolean getLocalCopy) [Inherited From MSVSS]

Set the getLocalCopy attribute.

protected void setInternalLabel (java.lang.String label) [Inherited From MSVSS]

Set the label attribute.

protected void setInternalLocalPath (java.lang.String localPath) [Inherited From MSVSS]

Set the local path comment attribute.

protected void setInternalNumDays (int numDays) [Inherited From MSVSS]

Set the num days attribute.

protected void setInternalOutputFilename (java.lang.String outputFileName) [Inherited From MSVSS]

Set the outputFileName comment attribute.

protected void setInternalQuiet (boolean quiet) [Inherited From MSVSS]

Set the quiet attribute.

protected void setInternalRecursive (boolean recursive) [Inherited From MSVSS]

Set the recursive attribute.

protected void setInternalStyle (java.lang.String style) [Inherited From MSVSS]

Set the style attribute.

protected void setInternalToDate (java.lang.String toDate) [Inherited From MSVSS]

Set the to date attribute.

protected void setInternalToLabel (java.lang.String toLabel) [Inherited From MSVSS]

Set the to label attribute.

protected void setInternalUser (java.lang.String user) [Inherited From MSVSS]

Set the user attribute.

protected void setInternalVersion (java.lang.String version) [Inherited From MSVSS]

Set the version attribute.

protected void setInternalWritable (boolean writable) [Inherited From MSVSS]

Set the writable attribute.

protected void setInternalWritableFiles (WritableFiles writableFiles) [Inherited From MSVSS]

Set the writableFiles attribute.

public void setLabel (java.lang.String label)

Label to get.

public void setLocalpath (Path localPath)

Override the project working directory.

public void setLocation (Location location) [Inherited From ProjectComponent]

Sets the file/location where this task was defined.

Sets the file/location where this task was defined.
Parameters:
- location - The file/location where this task was defined. Should not be null--use Location.UNKNOWN_LOCATION if the location isn't known.
See Also: Location.UNKNOWN_LOCATION,

publicfinal void setLogin (java.lang.String vssLogin) [Inherited From MSVSS]

public void setOwningTarget (Target target) [Inherited From Task]

Sets the target container of this task.

Sets the target container of this task.
Parameters:
- target - Target in whose scope this task belongs. May be null, indicating a top-level task.

public void setProject (Project project) [Inherited From ProjectComponent]

Sets the project object of this component.

Sets the project object of this component. This method is used by
Project when a component is added to it so that the component has
access to the functions of the project. It should not be used
for any other purpose.
Parameters:
- project - Project in whose scope this component belongs. Must not be null.

publicfinal void setQuiet (boolean quiet)

Enable quiet mode.

publicfinal void setRecursive (boolean recursive)

Get files recursively.

public void setRuntimeConfigurableWrapper (RuntimeConfigurable wrapper) [Inherited From Task]

Sets the wrapper to be used for runtime configuration.

Sets the wrapper to be used for runtime configuration.

This method should be used only by the ProjectHelper and Ant internals.
It is public to allow helper plugins to operate on tasks, normal tasks
should never use it.
Parameters:
- wrapper - The wrapper to be used for runtime configuration. May be null, in which case the next call to getRuntimeConfigurableWrapper will generate a new wrapper.

publicfinal void setServerpath (java.lang.String serverPath) [Inherited From MSVSS]

Directory where srssafe.ini resides.

Directory where srssafe.ini resides.
Parameters:
- serverPath - The path to the VSS server.

publicfinal void setSsdir (java.lang.String dir) [Inherited From MSVSS]

Directory where ss.exe resides.

Directory where ss.exe resides.
By default the task expects it to be in the PATH.
Parameters:
- dir - The directory containing ss.exe.

public void setTaskName (java.lang.String name) [Inherited From Task]

Sets the name to use in logging messages.

Sets the name to use in logging messages.
Parameters:
- name - The name to use in logging messages. Should not be null.

public void setTaskType (java.lang.String type) [Inherited From Task]

Sets the name with which the task has been invoked.

Sets the name with which the task has been invoked.
Parameters:
- type - The name the task has been invoked as. Should not be null.

public void setVersion (java.lang.String version)

Version to get.

publicfinal void setVsspath (java.lang.String vssPath) [Inherited From MSVSS]

SourceSafe path which specifies the project/file(s) you wish to perform the action on.

publicfinal void setWritable (boolean writable)

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

public void setWritableFiles (WritableFiles files)

Action taken when local files are writable.

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