org.apache.tools.ant.taskdefs.optional.starteam
Class StarTeamCheckin
public class StarTeamCheckin
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
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, 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.
|
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, java.io.File targetFolder) - Implements base-class abstract function to perform the checkout
operation on the files in each folder of the tree.
|
_setAsOfDate , _setAsOfDateFormat , _setLabel , execute , getAsOfDate , getExcludes , getFullRepositoryPath , getIDofLabelInUse , getIncludes , getLabel , getLabelID , getLabelInUse , getRootLocalFolder , getRootStarteamFolder , getViewConfiguredByDate , isForced , isPreloadFileInformation , isRecursive , isUsingRevisionLabel , isUsingViewLabel , logAsOfDate , logExcludes , logIncludes , logLabel , logOperationDescription , matchPatterns , setExcludes , setForced , setIncludes , setPreloadFileInformation , setRecursive , setRootLocalFolder , setRootStarteamFolder , shouldProcess , testPreconditions , visit |
createSnapshotView , disconnectFromServer , getPassword , getProjectname , getServer , getServername , getServerport , getTypeNames , getURL , getUserName , getUserName , getViewURL , getViewname , openView , setPassword , setProjectname , setServername , setServerport , setURL , setUserName , setViewname |
execute , getDescription , getLocation , getOwningTarget , getRuntimeConfigurableWrapper , getTaskName , getTaskType , getWrapper , handleErrorFlush , handleErrorOutput , handleFlush , handleInput , handleOutput , init , isInvalid , log , log , maybeConfigure , perform , reconfigure , setDescription , setLocation , setOwningTarget , setRuntimeConfigurableWrapper , setTaskName , setTaskType |
StarTeamCheckin
public StarTeamCheckin()
Constructor for StarTeamCheckin.
createSnapshotView
protected View createSnapshotView(View raw)
Override of base-class abstract function creates an
appropriately configured view. For checkins this is
always the current or "tip" view.
- createSnapshotView in interface StarTeamTask
raw
- the unconfigured View
- the snapshot
View
appropriately configured.
getComment
public String getComment()
Get the comment attribute for this operation
isAddUncontrolled
public boolean isAddUncontrolled()
Get the value of addUncontrolled.
- value of addUncontrolled.
logOperationDescription
protected void 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.
- logOperationDescription in interface TreeBasedTask
starteamrootFolder
- root folder in StarTeam for the operationtargetrootFolder
- root local folder for the operation
(whether specified by the user or not).
setAddUncontrolled
public void setAddUncontrolled(boolean addUncontrolled)
if true, any files or folders NOT in StarTeam will be
added to the repository. Defaults to "false".
addUncontrolled
- Value to assign to addUncontrolled.
setComment
public void setComment(String comment)
Optional checkin comment to be saved with the file.
comment
- Value to assign to comment.
setCreateFolders
public void setCreateFolders(boolean argCreateFolders)
Sets the value of createFolders
argCreateFolders
- Value to assign to this.createFolders
setUnlocked
public 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. If false, lock status will not change.
v
- true means do an unlocked checkout
false means leave status alone.
testPreconditions
protected void testPreconditions()
throws BuildException
Implements base-class abstract function to define tests for
any preconditons required by the task.
- testPreconditions in interface TreeBasedTask
BuildException
- thrown if both rootLocalFolder
and viewRootLocalFolder are defined
visit
protected void visit(Folder starteamFolder,
java.io.File targetFolder)
throws BuildException
Implements base-class abstract function to perform the checkout
operation on the files in each folder of the tree.
- visit in interface TreeBasedTask
starteamFolder
- the StarTeam folder to which files
will be checked intargetFolder
- local folder from which files will be checked in
Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.