| Method Summary |
|
| protected void | _setAsOfDate(String asOfDate)
non-public method callable only by derived classes that implement
setAsOfDate (so that derived tasks that do not accept this
parameter will fail if user attempts to use it. |
| protected void | _setAsOfDateFormat(String asOfDateFormat)
non-public method callable only by derived classes that implement
setAsOfDateFormat (so that derived tasks that do not accept this
parameter will fail if user attempts to use it. |
| protected void | _setLabel(String label)
protected function to allow subclasses to set the label (or not). |
| final public void | execute()
This method does the work of opening the supplied Starteam view and
calling the visit() method to perform the task. |
| protected String | getAsOfDate()
return the asOfDate entered by the user for internal use by derived
classes. |
| public String | getExcludes()
Gets the patterns from the exclude filter. |
| public static String | getFullRepositoryPath(com.starbase.starteam.File remotefile)
Return the full repository path name of a file. |
| protected int | getIDofLabelInUse()
Get the id of the label in use. |
| public String | getIncludes()
Gets the patterns from the include filter. |
| protected String | getLabel()
|
| protected int | getLabelID(View v)
Helper method calls on the StarTeam API to retrieve an ID number
for the specified view, corresponding to this.label. |
| protected Label | getLabelInUse()
|
| public String | getRootLocalFolder()
Returns the local folder specified by the user,
corresponding to the starteam folder for this operation
or null if not specified. |
| public String | getRootStarteamFolder()
|
| protected View | getViewConfiguredByDate(View raw)
If an asofDate parameter has been supplied by the user return a
StarTeam view based on the configuration of the StarTeam view
specified the user as of the date specified in the parameter. |
| public boolean | isForced()
Get the value of forced. |
| public boolean | isPreloadFileInformation()
Get the value of preloadFileInformation. |
| public boolean | isRecursive()
Get the value of recursive. |
| protected boolean | isUsingRevisionLabel()
returns true if a label has been specified and it is a revision label. |
| protected boolean | isUsingViewLabel()
returns true if a label has been specified and it is a view label. |
| protected void | logAsOfDate()
|
| protected void | logExcludes()
|
| protected void | logIncludes()
|
| protected void | logLabel()
show the label in the log and its type. |
| abstract 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 boolean | matchPatterns(String patterns, String pName)
Convenience method to see if a string match a one pattern
in given set of space-separated patterns.
Parameters:
patterns - the space-separated list of patterns.
Parameters:
pName - the name to look for matching. |
| public void | setExcludes(String excludes)
Declare files to exclude using standard excludes patterns; optional.
When filtering files, AntStarTeamCheckOut
uses an unmodified version of DirectoryScanner's
match method, so here are the patterns straight from the
Ant source code:
Matches a string against a pattern. |
| public void | setForced(boolean v)
Flag to force actions regardless of the status
that StarTeam is maintaining for the file; optional, default false. |
| public void | setIncludes(String includes)
Declare files to include using standard includes patterns; optional.
Parameters:
includes - A string of filter patterns to include. |
| public void | setPreloadFileInformation(boolean v)
Flag to set to preload file information from the server; optional,
default true. |
| public void | setRecursive(boolean v)
Flag to set to include files in subfolders in the operation; optional,
default true. |
| public void | setRootLocalFolder(String rootLocalFolder)
Set the local folder that will be the root of the tree
to which files are checked out; optional. |
| public void | setRootStarteamFolder(String rootStarteamFolder)
Set the root of the subtree in the StarTeam repository from which to
work; optional. |
| protected boolean | shouldProcess(String pName)
Look if the file should be processed by the task.
Don't process it if it fits no include filters or if
it fits an exclude filter.
Parameters:
pName - the item name to look for being included. |
| abstract protected void | testPreconditions()
Derived classes must override this method to define tests for
any preconditons required by the task. |
| abstract protected void | visit(Folder rootStarteamFolder, java.io.File rootLocalFolder)
|
