|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.tools.ant.ProjectComponent org.apache.tools.ant.Task org.apache.tools.ant.taskdefs.optional.starteam.StarTeamTask org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask org.apache.tools.ant.taskdefs.optional.starteam.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
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask |
---|
TreeBasedTask.UnmatchedFileMap |
Field Summary |
---|
Fields inherited from class org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask |
---|
DEFAULT_EXCLUDESETTING, DEFAULT_INCLUDESETTING |
Fields inherited from class org.apache.tools.ant.Task |
---|
target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
---|
description, location, project |
Constructor Summary | |
---|---|
StarTeamCheckin()
Constructor for StarTeamCheckin. |
Method Summary | |
---|---|
protected com.starbase.starteam.View |
createSnapshotView(com.starbase.starteam.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(com.starbase.starteam.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(com.starbase.starteam.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. |
Methods inherited from class org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask |
---|
_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 |
Methods inherited from class org.apache.tools.ant.taskdefs.optional.starteam.StarTeamTask |
---|
disconnectFromServer, getPassword, getProjectname, getServer, getServername, getServerport, getTypeNames, getURL, getUserName, getUserName, getViewname, getViewURL, openView, setPassword, setProjectname, setServername, setServerport, setURL, setUserName, setViewname |
Methods inherited from class org.apache.tools.ant.Task |
---|
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
---|
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public StarTeamCheckin()
Method Detail |
---|
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 com.starbase.starteam.View createSnapshotView(com.starbase.starteam.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(com.starbase.starteam.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(com.starbase.starteam.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 in
BuildException
- if any error occurs
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |