|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.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.StarTeamList
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
| 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 | |
|---|---|
StarTeamList()
|
|
| Method Summary | |
|---|---|
protected com.starbase.starteam.View |
createSnapshotView(com.starbase.starteam.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(com.starbase.starteam.File reposFile,
java.io.File localFile)
Log a repositary file and it's corresponding local file. |
protected void |
logOperationDescription(com.starbase.starteam.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(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 StarTeamList()
| Method Detail |
|---|
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 com.starbase.starteam.View createSnapshotView(com.starbase.starteam.View raw)
createSnapshotView in class StarTeamTaskraw - the unconfigured View
View appropriately configured.
protected void testPreconditions()
throws BuildException
testPreconditions in class TreeBasedTaskBuildException - thrown on incompatible params specifiedexecute()
protected void logOperationDescription(com.starbase.starteam.Folder starteamrootFolder,
java.io.File targetrootFolder)
logOperationDescription in class TreeBasedTaskstarteamrootFolder - 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 TreeBasedTaskstarteamFolder - the StarTeam folder from which files to be
checked outtargetFolder - the local mapping of rootStarteamFolder
BuildException - on error
protected void list(com.starbase.starteam.File reposFile,
java.io.File localFile)
throws java.io.IOException
reposFile - the repositary file to loglocalFile - the corresponding local file
java.io.IOException - on error getting information from files
protected static java.lang.String pad(java.lang.String s,
int padlen)
s - the string to padpadlen - the size of the padded string
protected static java.lang.String rpad(java.lang.String s,
int padlen)
s - the string to padpadlen - the size of the padded string
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||