Checks files into a StarTeam project.
Optionally adds files and in the local tree that
are not managed by the repository to its control.
Created: Sat Dec 15 20:26:07 2001
version: 1.0
logOperationDescription(Folder starteamrootFolder, java.io.File targetrootFolder) Implements base-class abstract function to emit to the log an
entry describing the parameters that will be used by this operation.
public void
setAddUncontrolled(boolean addUncontrolled) if true, any files or folders NOT in StarTeam will be
added to the repository.
public void
setComment(String comment) Optional checkin comment to be saved with the file.
setUnlocked(boolean v) Set to do an unlocked checkout; optional, default is false;
If true, file will be unlocked so that other users may
change it.
protected void
testPreconditions() Implements base-class abstract function to define tests for
any preconditons required by the task.
protected void
visit(Folder starteamFolder, java.io.File targetFolder) Implements base-class abstract function to perform the checkout
operation on the files in each folder of the tree.
Override of base-class abstract function creates an
appropriately configured view. For checkins this is
always the current or "tip" view.
Parameters: raw - the unconfigured View the snapshot View appropriately configured.
Implements base-class abstract function to emit to the log an
entry describing the parameters that will be used by this operation.
Parameters: starteamrootFolder - root folder in StarTeam for the operation Parameters: targetrootFolder - root local folder for the operation(whether specified by the user or not).
setAddUncontrolled
public void setAddUncontrolled(boolean addUncontrolled)(Code)
if true, any files or folders NOT in StarTeam will be
added to the repository. Defaults to "false".
Parameters: addUncontrolled - Value to assign to addUncontrolled.
Set to do an unlocked checkout; optional, default is false;
If true, file will be unlocked so that other users may
change it. If false, lock status will not change.
Parameters: v - true means do an unlocked checkoutfalse means leave status alone.
Implements base-class abstract function to define tests for
any preconditons required by the task.
exception: BuildException - thrown if both rootLocalFolderand viewRootLocalFolder are defined
Implements base-class abstract function to perform the checkout
operation on the files in each folder of the tree.
Parameters: starteamFolder - the StarTeam folder to which fileswill be checked in Parameters: targetFolder - local folder from which files will be checked in exception: BuildException - if any error occurs
Fields inherited from org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask