org.apache.tools.ant.taskdefs.optional.starteam
public class StarTeamCheckin extends TreeBasedTask
TreeBasedTask.UnmatchedFileMap
DEFAULT_EXCLUDESETTING, DEFAULT_INCLUDESETTING
description, location, project
Constructor and Description |
---|
StarTeamCheckin()
Constructor for StarTeamCheckin.
|
Modifier and Type | Method and Description |
---|---|
protected View |
createSnapshotView(View raw)
Override of base-class abstract function creates an
appropriately configured view.
|
java.lang.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(java.lang.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, matchPatterns, setExcludes, setForced, setIncludes, setPreloadFileInformation, setRecursive, setRootLocalFolder, setRootStarteamFolder, shouldProcess
disconnectFromServer, getPassword, getProjectname, getServer, getServername, getServerport, getTypeNames, getURL, getUserName, getUserName, getViewname, getViewURL, openView, setPassword, setProjectname, setServername, setServerport, setURL, setUserName, setViewname
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
public void setCreateFolders(boolean argCreateFolders)
argCreateFolders
- Value to assign to this.createFolderspublic java.lang.String getComment()
public void setComment(java.lang.String comment)
comment
- Value to assign to comment.public boolean isAddUncontrolled()
public void setAddUncontrolled(boolean addUncontrolled)
addUncontrolled
- Value to assign to addUncontrolled.public void setUnlocked(boolean v)
v
- true means do an unlocked checkout
false means leave status alone.protected View createSnapshotView(View raw)
createSnapshotView
in class StarTeamTask
raw
- the unconfigured View
View
appropriately configured.protected void testPreconditions() throws BuildException
testPreconditions
in class TreeBasedTask
BuildException
- thrown if both rootLocalFolder
and viewRootLocalFolder are definedexecute()
protected void logOperationDescription(Folder starteamrootFolder, java.io.File targetrootFolder)
logOperationDescription
in class TreeBasedTask
starteamrootFolder
- root folder in StarTeam for the operationtargetrootFolder
- root local folder for the operation
(whether specified by the user or not).protected void visit(Folder starteamFolder, java.io.File targetFolder) throws BuildException
visit
in class TreeBasedTask
starteamFolder
- the StarTeam folder to which files
will be checked intargetFolder
- local folder from which files will be checked inBuildException
- if any error occurs