Top Description Fields Constructors Methods
org.apache.tools.ant.taskdefs.optional.sos

public Class SOSCheckout

extends SOS
Class Inheritance
Imports
org.apache.tools.ant.types.Commandline
Retrieves and locks files in Visual SourceSafe via a SourceOffSite server.

Field Summary

Inherited from org.apache.tools.ant.taskdefs.optional.sos.SOS:
commandLine

Constructor Summary

AccessConstructor and Description
public
SOSCheckout()

Method Summary

Modifier and TypeMethod and Description
protected Commandline

Returns:

Commandline the generated command to be executed
buildCmdLine()

Implements abstract org.apache.tools.ant.taskdefs.optional.sos.SOS.buildCmdLine.

Build the command line

CheckOutFile required parameters: -server -name -password -database -project -file CheckOutFile optional parameters: -workdir -verbose -nocache -nocompression -soshome CheckOutProject required parameters: -server -name -password -database -project CheckOutProject optional parameters:-workdir -recursive -verbose -nocache -nocompression -soshome

public final void
setFile(String
The new file value
filename)

The filename to act upon.

public void
setRecursive(boolean
True for recursive operation.
recursive)

Flag to recursively apply the action.

Inherited from org.apache.tools.ant.taskdefs.optional.sos.SOS:
executegetCommentgetFilenamegetLabelgetLocalPathgetNoCachegetNoCompressgetOptionalAttributesgetPasswordgetProjectPathgetRecursivegetRequiredAttributesgetSosCommandgetSosHomegetSosServerPathgetUsernamegetVerbosegetVersiongetVssServerPathrunsetInternalCommentsetInternalFilenamesetInternalLabelsetInternalRecursivesetInternalVersionsetLocalPathsetNoCachesetNoCompresssetPasswordsetProjectPathsetSosCmdsetSosHomesetSosServerPathsetUsernamesetVerbosesetVssServerPath

Constructor Detail

SOSCheckoutback to summary
public SOSCheckout()

Method Detail

buildCmdLineback to summary
protected Commandline buildCmdLine()

Implements abstract org.apache.tools.ant.taskdefs.optional.sos.SOS.buildCmdLine.

Build the command line

CheckOutFile required parameters: -server -name -password -database -project -file
CheckOutFile optional parameters: -workdir -verbose -nocache -nocompression -soshome
CheckOutProject required parameters: -server -name -password -database -project
CheckOutProject optional parameters:-workdir -recursive -verbose -nocache -nocompression -soshome

Returns:Commandline

Commandline the generated command to be executed

Annotations
@Override
setFileback to summary
public final void setFile(String filename)

The filename to act upon. If no file is specified then the task acts upon the project.

Parameters
filename:String

The new file value

setRecursiveback to summary
public void setRecursive(boolean recursive)

Flag to recursively apply the action. Defaults to false.

Parameters
recursive:boolean

True for recursive operation.