org.apache.tools.ant.taskdefs.optional.starteam

Class StarTeamList

public class StarTeamList extends TreeBasedTask

Produces a listing of the contents of the StarTeam repository at the specified view and StarTeamFolder. Created: Tue Dec 25 06:51:14 2001

Version: 1.0

UNKNOWN: name="stlist" category="scm"

Method Summary
protected ViewcreateSnapshotView(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 voidlist(File reposFile, File localFile)
protected voidlogOperationDescription(Folder starteamrootFolder, File targetrootFolder)
extenders should emit to the log an entry describing the parameters that will be used by this operation.
protected static Stringpad(String s, int padlen)
protected static Stringrpad(String s, int padlen)
voidsetAsOfDate(String asOfDateParam)
List files, dates, and statuses as of this date; optional.
voidsetAsOfDateFormat(String asOfDateFormat)
Date Format with which asOfDate parameter to be parsed; optional.
voidsetLabel(String label)
List files, dates, and statuses as of this label; optional.
protected voidtestPreconditions()
Required base-class abstract function implementation checks for incompatible parameters.
protected voidvisit(Folder starteamFolder, File targetFolder)
Implements base-class abstract function to perform the checkout operation on the files in each folder of the tree.

Method Detail

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.

Parameters: raw the unconfigured View

Returns: the snapshot View appropriately configured.

list

protected void list(File reposFile, File localFile)

logOperationDescription

protected void logOperationDescription(Folder starteamrootFolder, File targetrootFolder)
extenders should emit to the log an entry describing the parameters that will be used by this operation.

Parameters: starteamrootFolder root folder in StarTeam for the operation targetrootFolder root local folder for the operation (whether specified by the user or not.

pad

protected static String pad(String s, int padlen)

rpad

protected static String rpad(String s, int padlen)

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.

Parameters: asOfDateParam the date as of which the listing to be made

Since: Ant 1.6

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.

Parameters: asOfDateFormat the SimpleDateFormat-compatible format string

Since: Ant 1.6

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.

Parameters: label the label to be listed

testPreconditions

protected void testPreconditions()
Required base-class abstract function implementation checks for incompatible parameters.

Throws: BuildException thrown on incompatible params specified

visit

protected void visit(Folder starteamFolder, File targetFolder)
Implements base-class abstract function to perform the checkout operation on the files in each folder of the tree.

Parameters: starteamFolder the StarTeam folder from which files to be checked out targetFolder the local mapping of rootStarteamFolder

Copyright