org.apache.tools.ant.taskdefs.optional.starteam
public class StarTeamCheckout extends TreeBasedTask
<taskdef name="starteamcheckout" classname="org.apache.tools.ant.taskdefs.StarTeamCheckout"/> <starteamcheckout username="BuildMaster" password="ant" starteamFolder="Source" starteamurl="servername:portnum/project/view" createworkingdirectories="true"/>
Version: 1.1
See Also: borland StarTeam Web Site
UNKNOWN: name="stcheckout" category="scm"
Method Summary | |
---|---|
protected View | createSnapshotView(View raw)
Override of base-class abstract function creates an
appropriately configured view for checkouts - either
the current view or a view from this.label or the raw
view itself in the case of a revision label.
|
boolean | getUseRepositoryTimeStamp()
returns the value of the useRepositoryTimestamp member
|
protected void | logOperationDescription(Folder starteamrootFolder, File targetrootFolder)
extenders should emit to the log an entry describing the parameters
that will be used by this operation.
|
void | setAsOfDate(String asOfDateParam)
List files, dates, and statuses as of this date; optional.
|
void | setAsOfDateFormat(String asOfDateFormat)
Date Format with which asOfDate parameter to be parsed; optional.
|
void | setConvertEOL(boolean value)
Set whether or not files should be checked out using the
local machine's EOL convention.
|
void | setCreateWorkingDirs(boolean value)
flag (defaults to true) to create all directories
that are in the Starteam repository even if they are empty.
|
void | setDeleteUncontrolled(boolean value)
Whether or not all local files not in StarTeam should be deleted.
|
void | setLabel(String label)
Sets the label StarTeam is to use for checkout; defaults to the most recent file.
|
void | setLocked(boolean v)
Set to do a locked checkout; optional default is false. |
void | setUnlocked(boolean v)
Set to do an unlocked checkout. |
void | setUseRepositoryTimeStamp(boolean useRepositoryTimeStamp)
sets the useRepositoryTimestmp member.
|
protected void | testPreconditions()
Implements base-class abstract function to define tests for
any preconditons required by the task.
|
protected void | visit(Folder starteamFolder, File targetFolder)
Implements base-class abstract function to perform the checkout
operation on the files in each folder of the tree.
|
Parameters: raw the unconfigured View
Returns: the snapshot View
appropriately configured.
Throws: BuildException on error
Returns: the value of the useRepositoryTimestamp member
Parameters: starteamrootFolder root folder in StarTeam for the operation targetrootFolder root local folder for the operation (whether specified by the user or not.
Parameters: asOfDateParam the date as of which the listing to be made
Since: Ant 1.6
Parameters: asOfDateFormat the SimpleDateFormat-compatible format string
Since: Ant 1.6
true
.Parameters: value the value to set the attribute to.
Parameters: value the value to set the attribute to.
true
.Parameters: value the value to set the attribute to.
Parameters: label the label to be used
Parameters: v True to do a locked checkout, false to checkout without changing status/.
Throws: BuildException if both locked and unlocked are set true
Parameters: v True to do an unlocked checkout, false to checkout without changing status.
Throws: BuildException if both locked and unlocked are set true
Parameters: useRepositoryTimeStamp true means checked out files will get the repository timestamp. false means the checked out files will be timestamped at the time of checkout.
Throws: BuildException thrown if both rootLocalFolder and viewRootLocalFolder are defined
Parameters: starteamFolder the StarTeam folder from which files to be checked out targetFolder the local mapping of rootStarteamFolder
Throws: BuildException if any error occurs