Java Doc for StarTeamCheckout.java in  » Build » ANT » org » apache » tools » ant » taskdefs » optional » starteam » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Build » ANT » org.apache.tools.ant.taskdefs.optional.starteam 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.tools.ant.taskdefs.optional.starteam.StarTeamTask
   org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask
      org.apache.tools.ant.taskdefs.optional.starteam.StarTeamCheckout

StarTeamCheckout
public class StarTeamCheckout extends TreeBasedTask (Code)
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:    borland StarTeam Web Site




Method Summary
protected  ViewcreateSnapshotView(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.
public  booleangetUseRepositoryTimeStamp()
    
protected  voidlogOperationDescription(Folder starteamrootFolder, java.io.File targetrootFolder)
     extenders should emit to the log an entry describing the parameters that will be used by this operation.
public  voidsetAsOfDate(String asOfDateParam)
     List files, dates, and statuses as of this date; optional.
public  voidsetAsOfDateFormat(String asOfDateFormat)
     Date Format with which asOfDate parameter to be parsed; optional.
public  voidsetConvertEOL(boolean value)
     Set whether or not files should be checked out using the local machine's EOL convention.
public  voidsetCreateWorkingDirs(boolean value)
     flag (defaults to true) to create all directories that are in the Starteam repository even if they are empty.
public  voidsetDeleteUncontrolled(boolean value)
     Whether or not all local files not in StarTeam should be deleted.
public  voidsetLabel(String label)
     Sets the label StarTeam is to use for checkout; defaults to the most recent file.
public  voidsetLocked(boolean v)
     Set to do a locked checkout; optional default is false.
public  voidsetUnlocked(boolean v)
     Set to do an unlocked checkout.
public  voidsetUseRepositoryTimeStamp(boolean useRepositoryTimeStamp)
     sets the useRepositoryTimestmp member.
protected  voidtestPreconditions()
     Implements base-class abstract function to define tests for any preconditons required by the task.
protected  voidvisit(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.



Method Detail
createSnapshotView
protected View createSnapshotView(View raw) throws BuildException(Code)
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.
Parameters:
  raw - the unconfigured View the snapshot View appropriately configured.
exception:
  BuildException - on error



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



logOperationDescription
protected void logOperationDescription(Folder starteamrootFolder, java.io.File targetrootFolder)(Code)
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
Parameters:
  targetrootFolder - root local folder for the operation (whether specifiedby the user or not.



setAsOfDate
public void setAsOfDate(String asOfDateParam)(Code)
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)(Code)
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)(Code)
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)(Code)
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)(Code)
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)(Code)
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(Code)
Set to do a locked checkout; optional default is false.
Parameters:
  v - True to do a locked checkout, false to checkout withoutchanging status/.
exception:
  BuildException - if both locked and unlocked are set true



setUnlocked
public void setUnlocked(boolean v) throws BuildException(Code)
Set to do an unlocked checkout. Default is false;
Parameters:
  v - True to do an unlocked checkout, false to checkout withoutchanging status.
exception:
  BuildException - if both locked and unlocked are set true



setUseRepositoryTimeStamp
public void setUseRepositoryTimeStamp(boolean useRepositoryTimeStamp)(Code)
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 timeof checkout.



testPreconditions
protected void testPreconditions() throws BuildException(Code)
Implements base-class abstract function to define tests for any preconditons required by the task.
exception:
  BuildException - thrown if both rootLocalFolderand viewRootLocalFolder are defined



visit
protected void visit(Folder starteamFolder, java.io.File targetFolder) throws BuildException(Code)
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 bechecked out
Parameters:
  targetFolder - the local mapping of rootStarteamFolder
exception:
  BuildException - if any error occurs



Fields inherited from org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask
final public static String DEFAULT_EXCLUDESETTING(Code)(Java Doc)
final public static String DEFAULT_INCLUDESETTING(Code)(Java Doc)

Methods inherited from org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask
protected void _setAsOfDate(String asOfDate)(Code)(Java Doc)
protected void _setAsOfDateFormat(String asOfDateFormat)(Code)(Java Doc)
protected void _setLabel(String label)(Code)(Java Doc)
final public void execute() throws BuildException(Code)(Java Doc)
protected String getAsOfDate()(Code)(Java Doc)
public String getExcludes()(Code)(Java Doc)
public static String getFullRepositoryPath(com.starbase.starteam.File remotefile)(Code)(Java Doc)
protected int getIDofLabelInUse()(Code)(Java Doc)
public String getIncludes()(Code)(Java Doc)
protected String getLabel()(Code)(Java Doc)
protected int getLabelID(View v) throws BuildException(Code)(Java Doc)
protected Label getLabelInUse()(Code)(Java Doc)
public String getRootLocalFolder()(Code)(Java Doc)
public String getRootStarteamFolder()(Code)(Java Doc)
protected View getViewConfiguredByDate(View raw) throws BuildException(Code)(Java Doc)
public boolean isForced()(Code)(Java Doc)
public boolean isPreloadFileInformation()(Code)(Java Doc)
public boolean isRecursive()(Code)(Java Doc)
protected boolean isUsingRevisionLabel()(Code)(Java Doc)
protected boolean isUsingViewLabel()(Code)(Java Doc)
protected void logAsOfDate()(Code)(Java Doc)
protected void logExcludes()(Code)(Java Doc)
protected void logIncludes()(Code)(Java Doc)
protected void logLabel()(Code)(Java Doc)
abstract protected void logOperationDescription(Folder starteamrootFolder, java.io.File targetrootFolder)(Code)(Java Doc)
protected boolean matchPatterns(String patterns, String pName)(Code)(Java Doc)
public void setExcludes(String excludes)(Code)(Java Doc)
public void setForced(boolean v)(Code)(Java Doc)
public void setIncludes(String includes)(Code)(Java Doc)
public void setPreloadFileInformation(boolean v)(Code)(Java Doc)
public void setRecursive(boolean v)(Code)(Java Doc)
public void setRootLocalFolder(String rootLocalFolder)(Code)(Java Doc)
public void setRootStarteamFolder(String rootStarteamFolder)(Code)(Java Doc)
protected boolean shouldProcess(String pName)(Code)(Java Doc)
abstract protected void testPreconditions() throws BuildException(Code)(Java Doc)
abstract protected void visit(Folder rootStarteamFolder, java.io.File rootLocalFolder) throws BuildException(Code)(Java Doc)

Methods inherited from org.apache.tools.ant.taskdefs.optional.starteam.StarTeamTask
abstract protected View createSnapshotView(View rawview) throws BuildException(Code)(Java Doc)
final protected void disconnectFromServer()(Code)(Java Doc)
final public String getPassword()(Code)(Java Doc)
final public String getProjectname()(Code)(Java Doc)
final protected Server getServer()(Code)(Java Doc)
final public String getServername()(Code)(Java Doc)
final public String getServerport()(Code)(Java Doc)
final protected TypeNames getTypeNames()(Code)(Java Doc)
final public String getURL()(Code)(Java Doc)
final public String getUserName()(Code)(Java Doc)
final protected String getUserName(int userID)(Code)(Java Doc)
final protected String getViewURL()(Code)(Java Doc)
final public String getViewname()(Code)(Java Doc)
protected View openView() throws BuildException(Code)(Java Doc)
final public void setPassword(String password)(Code)(Java Doc)
final public void setProjectname(String projectname)(Code)(Java Doc)
final public void setServername(String servername)(Code)(Java Doc)
final public void setServerport(String serverport)(Code)(Java Doc)
final public void setURL(String url)(Code)(Java Doc)
final public void setUserName(String userName)(Code)(Java Doc)
final public void setViewname(String viewname)(Code)(Java Doc)

w__w___w___._j__a__va_2s__._c__om_ | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.