org.apache.tools.ant.taskdefs.optional.starteam
public class StarTeamList extends TreeBasedTask
TreeBasedTask.UnmatchedFileMap
DEFAULT_EXCLUDESETTING, DEFAULT_INCLUDESETTING
description, location, project
Constructor and Description |
---|
StarTeamList() |
Modifier and Type | Method and Description |
---|---|
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 java.lang.String |
pad(java.lang.String s,
int padlen)
Return a padded string.
|
protected static java.lang.String |
rpad(java.lang.String s,
int padlen)
Return a right padded string.
|
void |
setAsOfDate(java.lang.String asOfDateParam)
List files, dates, and statuses as of this date; optional.
|
void |
setAsOfDateFormat(java.lang.String asOfDateFormat)
Date Format with which asOfDate parameter to be parsed; optional.
|
void |
setLabel(java.lang.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, 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 setLabel(java.lang.String label)
label
- the label to be listedpublic void setAsOfDate(java.lang.String asOfDateParam)
asOfDateParam
- the date as of which the listing to be madepublic void setAsOfDateFormat(java.lang.String asOfDateFormat)
asOfDateFormat
- the SimpleDateFormat-compatible format stringprotected 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 on incompatible params specifiedexecute()
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 from which files to be
checked outtargetFolder
- the local mapping of rootStarteamFolderBuildException
- on errorprotected void list(File reposFile, java.io.File localFile) throws java.io.IOException
reposFile
- the repositary file to loglocalFile
- the corresponding local filejava.io.IOException
- on error getting information from filesprotected static java.lang.String pad(java.lang.String s, int padlen)
s
- the string to padpadlen
- the size of the padded stringprotected static java.lang.String rpad(java.lang.String s, int padlen)
s
- the string to padpadlen
- the size of the padded string