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

Class StarTeamCheckout


public class StarTeamCheckout
extends TreeBasedTask

Checks out files from a StarTeam project. It also creates all working directories on the local directory if appropriate. Ant Usage:
 <taskdef name="starteamcheckout"
 classname="org.apache.tools.ant.taskdefs.StarTeamCheckout"/>
 <starteamcheckout username="BuildMaster" password="ant" starteamFolder="Source"
 starteamurl="servername:portnum/project/view"
 createworkingdirectories="true"/>
 

Version:
1.1

See Also:
StarBase Web Site

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

description, location, target, taskName, taskType, wrapper

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

project

Method Summary

protected View
createSnapshotView(View raw)
Override of base-class abstract function creates an appropriately configured view for checkouts - either the current view or a view from this.label or the raw view itself in the case of a revision label.
boolean
getUseRepositoryTimeStamp()
returns the value of the useRepositoryTimestamp member
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.
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
setConvertEOL(boolean value)
Set whether or not files should be checked out using the local machine's EOL convention.
void
setCreateWorkingDirs(boolean value)
flag (defaults to true) to create all directories that are in the Starteam repository even if they are empty.
void
setDeleteUncontrolled(boolean value)
Whether or not all local files not in StarTeam should be deleted.
void
setLabel(String label)
Sets the label StarTeam is to use for checkout; defaults to the most recent file.
void
setLocked(boolean v)
Set to do a locked checkout; optional default is false.
void
setUnlocked(boolean v)
Set to do an unlocked checkout.
void
setUseRepositoryTimeStamp(boolean useRepositoryTimeStamp)
sets the useRepositoryTimestmp member.
protected void
testPreconditions()
Implements base-class abstract function to define tests for any preconditons required by the task.
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.

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, logOperationDescription, matchPatterns, setExcludes, setForced, setIncludes, setPreloadFileInformation, setRecursive, setRootLocalFolder, setRootStarteamFolder, shouldProcess, testPreconditions, visit

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

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

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

execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

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

getProject, log, log, setProject

Method Details

createSnapshotView

protected View createSnapshotView(View raw)
            throws BuildException
Override of base-class abstract function creates an appropriately configured view for checkouts - either the current view or a view from this.label or the raw view itself in the case of a revision label.
Overrides:
createSnapshotView in interface StarTeamTask

Parameters:
raw - the unconfigured View

Returns:
the snapshot View appropriately configured.

Throws:
BuildException -


getUseRepositoryTimeStamp

public boolean getUseRepositoryTimeStamp()
returns the value of the useRepositoryTimestamp member

Returns:
the value of the useRepositoryTimestamp member


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.
Overrides:
logOperationDescription in interface TreeBasedTask

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


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


setConvertEOL

public void setConvertEOL(boolean value)
Set whether or not files should be checked out using the local machine's EOL convention. Optional, defaults to true.

Parameters:
value - the value to set the attribute to.


setCreateWorkingDirs

public void setCreateWorkingDirs(boolean value)
flag (defaults to true) to create all directories that are in the Starteam repository even if they are empty.

Parameters:
value - the value to set the attribute to.


setDeleteUncontrolled

public void setDeleteUncontrolled(boolean value)
Whether or not all local files not in StarTeam should be deleted. Optional, defaults to true.

Parameters:
value - the value to set the attribute to.


setLabel

public void setLabel(String label)
Sets the label StarTeam is to use for checkout; defaults to the most recent file. The label must exist in starteam or an exception will be thrown.

Parameters:
label - the label to be used


setLocked

public void setLocked(boolean v)
            throws BuildException
Set to do a locked checkout; optional default is false.

Parameters:
v - True to do a locked checkout, false to checkout without changing status/.

Throws:
BuildException - if both locked and unlocked are set true


setUnlocked

public void setUnlocked(boolean v)
            throws BuildException
Set to do an unlocked checkout. Default is false;

Parameters:
v - True to do an unlocked checkout, false to checkout without changing status.

Throws:
BuildException - if both locked and unlocked are set true


setUseRepositoryTimeStamp

public void setUseRepositoryTimeStamp(boolean useRepositoryTimeStamp)
sets the useRepositoryTimestmp member.

Parameters:
useRepositoryTimeStamp - true means checked out files will get the repository timestamp. false means the checked out files will be timestamped at the time of checkout.


testPreconditions

protected void testPreconditions()
            throws BuildException
Implements base-class abstract function to define tests for any preconditons required by the task.
Overrides:
testPreconditions in interface TreeBasedTask

Throws:
BuildException - thrown if both rootLocalFolder and viewRootLocalFolder are defined


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.
Overrides:
visit in interface TreeBasedTask

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

Throws:
BuildException - if any error occurs


Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.