Java Doc for StarTeamTask.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.Task
   org.apache.tools.ant.taskdefs.optional.starteam.StarTeamTask

All known Subclasses:   org.apache.tools.ant.taskdefs.optional.starteam.StarTeamLabel,  org.apache.tools.ant.taskdefs.optional.starteam.TreeBasedTask,
StarTeamTask
abstract public class StarTeamTask extends Task (Code)
Common super class for all StarTeam tasks. At this level of the hierarchy we are concerned only with obtaining a connection to the StarTeam server. The subclass TreeBasedTask, also abstract defines the tree-walking behavior common to many subtasks.
See Also:   TreeBasedTask
version:
   1.1




Method Summary
abstract protected  ViewcreateSnapshotView(View rawview)
     Derived classes must override createSnapshotView defining the kind of configured view appropriate to its task.
final protected  voiddisconnectFromServer()
     disconnects from the StarTeam server.
final public  StringgetPassword()
    
final public  StringgetProjectname()
    
final protected  ServergetServer()
     returns a reference to the server which may be used for informational purposes by subclasses.
final public  StringgetServername()
    
final public  StringgetServerport()
    
final protected  TypeNamesgetTypeNames()
     returns a list of TypeNames known to the server.
final public  StringgetURL()
    
final public  StringgetUserName()
    
final protected  StringgetUserName(int userID)
     Returns the name of the user with the supplied ID or a blank string if user not found.
final protected  StringgetViewURL()
     returns an URL string useful for interacting with many StarTeamFinder methods.
final public  StringgetViewname()
    
protected  ViewopenView()
     All subclasses will call on this method to open the view needed for processing.
final public  voidsetPassword(String password)
     set the password to be used for login; required.
final public  voidsetProjectname(String projectname)
     set the name of the StarTeam project to be acted on; required if URL is not set.
final public  voidsetServername(String servername)
     Set the name of StarTeamServer; required if URL is not set.
final public  voidsetServerport(String serverport)
     set the port number of the StarTeam connection; required if URL is not set.
final public  voidsetURL(String url)
     Set the server name, server port, project name and project folder in one shot; optional, but the server connection must be specified somehow.
final public  voidsetUserName(String userName)
    
final public  voidsetViewname(String viewname)
     set the name of the StarTeam view to be acted on; required if URL is not set.



Method Detail
createSnapshotView
abstract protected View createSnapshotView(View rawview) throws BuildException(Code)
Derived classes must override createSnapshotView defining the kind of configured view appropriate to its task.
Parameters:
  rawview - the unconfigured View the snapshot View appropriately configured.
throws:
  BuildException - on error



disconnectFromServer
final protected void disconnectFromServer()(Code)
disconnects from the StarTeam server. Should be called from the finally clause of every StarTeamTask-based execute method.



getPassword
final public String getPassword()(Code)
returns the password used for login the password used for login



getProjectname
final public String getProjectname()(Code)
returns the name of the StarTeam project to be acted on the name of the StarTeam project to be acted on
See Also:   StarTeamTask.getURL()



getServer
final protected Server getServer()(Code)
returns a reference to the server which may be used for informational purposes by subclasses. a reference to the server



getServername
final public String getServername()(Code)
returns the name of the StarTeamServer the name of the StarTeam server
See Also:   StarTeamTask.getURL()



getServerport
final public String getServerport()(Code)
returns the port number of the StarTeam connection the port number of the StarTeam connection
See Also:   StarTeamTask.getURL()



getTypeNames
final protected TypeNames getTypeNames()(Code)
returns a list of TypeNames known to the server. a reference to the server's TypeNames



getURL
final public String getURL()(Code)
a convenience method which returns the whole StarTeam connection information as a single URL string of a String of the form"servername:portnum/project/view"
See Also:   StarTeamTask.getServername()
See Also:   StarTeamTask.getServerport()
See Also:   StarTeamTask.getProjectname()
See Also:   StarTeamTask.getViewname()



getUserName
final public String getUserName()(Code)
returns the name of the StarTeam user the name of the StarTeam user



getUserName
final protected String getUserName(int userID)(Code)
Returns the name of the user with the supplied ID or a blank string if user not found.
Parameters:
  userID - a user's ID the name of the user with ID userID



getViewURL
final protected String getViewURL()(Code)
returns an URL string useful for interacting with many StarTeamFinder methods. the URL string for this task.



getViewname
final public String getViewname()(Code)
returns the name of the StarTeam view to be acted on the name of the StarTeam view to be acted on
See Also:   StarTeamTask.getURL()



openView
protected View openView() throws BuildException(Code)
All subclasses will call on this method to open the view needed for processing. This method also saves a reference to the Server that may be accessed for information at various points in the process. the View that will be used for processing.
See Also:   StarTeamTask.createSnapshotView(View)
See Also:   StarTeamTask.getServer()
throws:
  BuildException - on error



setPassword
final public void setPassword(String password)(Code)
set the password to be used for login; required.
Parameters:
  password - the password to be used for login



setProjectname
final public void setProjectname(String projectname)(Code)
set the name of the StarTeam project to be acted on; required if URL is not set.
Parameters:
  projectname - the name of the StarTeam project to be acted on
See Also:   StarTeamTask.setURL(String)



setServername
final public void setServername(String servername)(Code)
Set the name of StarTeamServer; required if URL is not set.
Parameters:
  servername - a String value
See Also:   StarTeamTask.setURL(String)



setServerport
final public void setServerport(String serverport)(Code)
set the port number of the StarTeam connection; required if URL is not set.
Parameters:
  serverport - port number to be set
See Also:   StarTeamTask.setURL(String)



setURL
final public void setURL(String url)(Code)
Set the server name, server port, project name and project folder in one shot; optional, but the server connection must be specified somehow.
Parameters:
  url - a String of the form"servername:portnum/project/view"
See Also:   StarTeamTask.setServername(String)
See Also:   StarTeamTask.setServerport(String)
See Also:   StarTeamTask.setProjectname(String)
See Also:   StarTeamTask.setViewname(String)



setUserName
final public void setUserName(String userName)(Code)
set the name of the StarTeam user, needed for the connection
Parameters:
  userName - name of the user to be logged in



setViewname
final public void setViewname(String viewname)(Code)
set the name of the StarTeam view to be acted on; required if URL is not set.
Parameters:
  viewname - the name of the StarTeam view to be acted on
See Also:   StarTeamTask.setURL(String)



Fields inherited from org.apache.tools.ant.Task
protected Target target(Code)(Java Doc)
protected String taskName(Code)(Java Doc)
protected String taskType(Code)(Java Doc)
protected RuntimeConfigurable wrapper(Code)(Java Doc)

Methods inherited from org.apache.tools.ant.Task
final public void bindToOwner(Task owner)(Code)(Java Doc)
public void execute() throws BuildException(Code)(Java Doc)
public Target getOwningTarget()(Code)(Java Doc)
public RuntimeConfigurable getRuntimeConfigurableWrapper()(Code)(Java Doc)
public String getTaskName()(Code)(Java Doc)
public String getTaskType()(Code)(Java Doc)
protected RuntimeConfigurable getWrapper()(Code)(Java Doc)
protected void handleErrorFlush(String output)(Code)(Java Doc)
protected void handleErrorOutput(String output)(Code)(Java Doc)
protected void handleFlush(String output)(Code)(Java Doc)
protected int handleInput(byte[] buffer, int offset, int length) throws IOException(Code)(Java Doc)
protected void handleOutput(String output)(Code)(Java Doc)
public void init() throws BuildException(Code)(Java Doc)
final protected boolean isInvalid()(Code)(Java Doc)
public void log(String msg)(Code)(Java Doc)
public void log(String msg, int msgLevel)(Code)(Java Doc)
public void log(Throwable t, int msgLevel)(Code)(Java Doc)
public void log(String msg, Throwable t, int msgLevel)(Code)(Java Doc)
public void maybeConfigure() throws BuildException(Code)(Java Doc)
final public void perform()(Code)(Java Doc)
public void reconfigure()(Code)(Java Doc)
public void setOwningTarget(Target target)(Code)(Java Doc)
public void setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)(Code)(Java Doc)
public void setTaskName(String name)(Code)(Java Doc)
public void setTaskType(String type)(Code)(Java Doc)

w_ww__.___j___a___va__2__s__.__c_o__m___ | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.