org.apache.tools.ant.taskdefs.optional.starteam
public class StarTeamCheckin extends TreeBasedTask
Version: 1.0
UNKNOWN: name="stcheckin" category="scm" product="Starteam"
Constructor Summary | |
---|---|
StarTeamCheckin()
Constructor for StarTeamCheckin. |
Method Summary | |
---|---|
protected View | createSnapshotView(View raw)
Override of base-class abstract function creates an
appropriately configured view. |
String | getComment()
Get the comment attribute for this operation |
boolean | isAddUncontrolled()
Get the value of addUncontrolled. |
protected void | logOperationDescription(Folder starteamrootFolder, File targetrootFolder)
Implements base-class abstract function to emit to the log an
entry describing the parameters that will be used by this operation.
|
void | setAddUncontrolled(boolean addUncontrolled)
if true, any files or folders NOT in StarTeam will be
added to the repository. |
void | setComment(String comment)
Optional checkin comment to be saved with the file. |
void | setCreateFolders(boolean argCreateFolders)
Sets the value of createFolders
|
void | 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, 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.
Returns: value of comment.
Returns: value of addUncontrolled.
Parameters: starteamrootFolder root folder in StarTeam for the operation targetrootFolder root local folder for the operation (whether specified by the user or not).
Parameters: addUncontrolled Value to assign to addUncontrolled.
Parameters: comment Value to assign to comment.
Parameters: argCreateFolders Value to assign to this.createFolders
Parameters: v true means do an unlocked checkout false means leave status alone.
Throws: BuildException thrown if both rootLocalFolder and viewRootLocalFolder are defined
Parameters: starteamFolder the StarTeam folder to which files will be checked in targetFolder local folder from which files will be checked in
Throws: BuildException if any error occurs