StarTeamList (Apache Ant API)

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

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.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

Author:

Steve Cohen

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

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

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)
protected static java.lang.String	pad(java.lang.String s, int padlen)
protected static java.lang.String	rpad(java.lang.String s, int padlen)
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 is a no-op here.
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

_setLabel, delistLocalFile, execute, getExcludes, getIncludes, getLabelID, getRootLocalFolder, getRootStarteamFolder, isForced, isRecursive, listLocalFiles, matchPatterns, setExcludes, setForced, setIncludes, setRecursive, setRootLocalFolder, setRootStarteamFolder, shouldProcess

Methods inherited from class org.apache.tools.ant.taskdefs.optional.starteam.StarTeamTask

getPassword, getProjectname, getServer, getServername, getServerport, getURL, getUserName, getUserName, getViewname, openView, setPassword, setProjectname, setServername, setServerport, setURL, setUserName, setViewname

Methods inherited from class org.apache.tools.ant.Task

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StarTeamList

public StarTeamList()

Method Detail

setLabel

public void setLabel(java.lang.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

createSnapshotView

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.

Specified by:

createSnapshotView in class StarTeamTask

Parameters:

raw - the unconfigured View

Returns:

the snapshot View appropriately configured.

testPreconditions

protected void testPreconditions()
                          throws BuildException

Required base-class abstract function implementation is a no-op here.

Specified by:

testPreconditions in class TreeBasedTask

Throws:

BuildException - not thrown in this implementation

See Also:

execute()

visit

protected void visit(com.starbase.starteam.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.

Specified by:

visit in class TreeBasedTask

Parameters:

starteamFolder - the StarTeam folder from which files to be checked out

targetFolder - the local mapping of rootStarteamFolder

BuildException

list

protected void list(com.starbase.starteam.File reposFile,
                    java.io.File localFile)
             throws java.io.IOException

java.io.IOException

pad

protected static java.lang.String pad(java.lang.String s,
                                      int padlen)

rpad

protected static java.lang.String rpad(java.lang.String s,
                                       int padlen)