org.apache.tools.ant.taskdefs.optional.starteam
Class StarTeamList
- Cloneable
public class StarTeamList
Produces a listing of the contents of the StarTeam repository
at the specified view and StarTeamFolder.
Created: Tue Dec 25 06:51:14 2001
protected View | createSnapshotView(View raw) - Override of base-class abstract function creates an
appropriately configured view for checkoutlists - either
the current view or a view from this.label.
|
protected void | list(File reposFile, java.io.File localFile) - Log a repositary file and it's corresponding local file.
|
protected void | logOperationDescription(Folder starteamrootFolder, java.io.File targetrootFolder) - extenders should emit to the log an entry describing the parameters
that will be used by this operation.
|
protected static String | pad(String s, int padlen) - Return a padded string.
|
protected static String | rpad(String s, int padlen) - Return a right padded string.
|
void | setAsOfDate(String asOfDateParam) - List files, dates, and statuses as of this date; optional.
|
void | setAsOfDateFormat(String asOfDateFormat) - Date Format with which asOfDate parameter to be parsed; optional.
|
void | setLabel(String label) - List files, dates, and statuses as of this label; optional.
|
protected void | testPreconditions() - Required base-class abstract function implementation checks for
incompatible parameters.
|
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 |
bindToOwner , execute , getOwningTarget , getRuntimeConfigurableWrapper , getTaskName , getTaskType , getWrapper , handleErrorFlush , handleErrorOutput , handleFlush , handleInput , handleOutput , init , isInvalid , log , log , log , log , maybeConfigure , perform , reconfigure , setOwningTarget , setRuntimeConfigurableWrapper , setTaskName , setTaskType |
createSnapshotView
protected View createSnapshotView(View raw)
Override of base-class abstract function creates an
appropriately configured view for checkoutlists - either
the current view or a view from this.label.
- createSnapshotView in interface StarTeamTask
raw
- the unconfigured View
- the snapshot
View
appropriately configured.
list
protected void list(File reposFile,
java.io.File localFile)
throws IOException
Log a repositary file and it's corresponding local file.
reposFile
- the repositary file to loglocalFile
- the corresponding local file
logOperationDescription
protected void logOperationDescription(Folder starteamrootFolder,
java.io.File targetrootFolder)
extenders should 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.
pad
protected static String pad(String s,
int padlen)
Return a padded string.
s
- the string to padpadlen
- the size of the padded string
rpad
protected static String rpad(String s,
int padlen)
Return a right padded string.
s
- the string to padpadlen
- the size of the padded string
setAsOfDate
public void setAsOfDate(String asOfDateParam)
List files, dates, and statuses as of this date; optional.
If not specified, the most recent version of each file will be listed.
asOfDateParam
- the date as of which the listing to be made
setAsOfDateFormat
public void setAsOfDateFormat(String asOfDateFormat)
Date Format with which asOfDate parameter to be parsed; optional.
Must be a SimpleDateFormat compatible string.
If not specified, and asOfDateParam is specified, parse will use ISO8601
datetime and date formats.
asOfDateFormat
- the SimpleDateFormat-compatible format string
setLabel
public void setLabel(String label)
List files, dates, and statuses as of this label; optional.
The label must exist in starteam or an exception will be thrown.
If not specified, the most recent version of each file will be listed.
label
- the label to be listed
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 from which files to be
checked outtargetFolder
- the local mapping of rootStarteamFolder