org.apache.tools.ant.taskdefs.optional.starteam
public abstract class StarTeamTask extends Task
TreeBasedTask
,
also abstract defines the tree-walking behavior common to many subtasks.
Version: 1.1
See Also: TreeBasedTask
Method Summary | |
---|---|
protected abstract View | createSnapshotView(View rawview)
Derived classes must override createSnapshotView
defining the kind of configured view appropriate to its task.
|
protected void | disconnectFromServer()
disconnects from the StarTeam server. |
String | getPassword()
returns the password used for login
|
String | getProjectname()
returns the name of the StarTeam project to be acted on
|
protected Server | getServer()
returns a reference to the server which may be used for informational
purposes by subclasses.
|
String | getServername()
returns the name of the StarTeamServer
|
String | getServerport()
returns the port number of the StarTeam connection
|
protected TypeNames | getTypeNames()
returns a list of TypeNames known to the server.
|
String | getURL()
a convenience method which returns the whole StarTeam
connection information as a single URL string of
|
String | getUserName()
returns the name of the StarTeam user
|
protected String | getUserName(int userID)
Returns the name of the user with the supplied ID or a blank string
if user not found.
|
String | getViewname()
returns the name of the StarTeam view to be acted on
|
protected String | getViewURL()
returns an URL string useful for interacting with many StarTeamFinder
methods.
|
protected View | openView()
All subclasses will call on this method to open the view needed for
processing. |
void | setPassword(String password)
set the password to be used for login; required.
|
void | setProjectname(String projectname)
set the name of the StarTeam project to be acted on;
required if URL is not set.
|
void | setServername(String servername)
Set the name of StarTeamServer;
required if URL is not set. |
void | setServerport(String serverport)
set the port number of the StarTeam connection;
required if URL is not set. |
void | setURL(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.
|
void | setUserName(String userName)
set the name of the StarTeam user, needed for the connection
|
void | setViewname(String viewname)
set the name of the StarTeam view to be acted on;
required if URL is not set.
|
createSnapshotView
defining the kind of configured view appropriate to its task.
Parameters: rawview the unconfigured View
Returns: the snapshot View
appropriately configured.
Throws: BuildException on error
Returns: the password used for login
Returns: the name of the StarTeam project to be acted on
See Also: getURL
Returns: a reference to the server
Returns: the name of the StarTeam server
See Also: getURL
Returns: the port number of the StarTeam connection
See Also: getURL
Returns: a reference to the server's TypeNames
Returns: a String
of the form
"servername:portnum/project/view"
See Also: getServername getServerport getProjectname getViewname
Returns: the name of the StarTeam user
Parameters: userID a user's ID
Returns: the name of the user with ID userID
Returns: the name of the StarTeam view to be acted on
See Also: getURL
Returns: the URL string for this task.
Server
that may be accessed for information at various
points in the process.
Returns: the View
that will be used for processing.
Throws: BuildException on error
See Also: createSnapshotView getServer
Parameters: password the password to be used for login
Parameters: projectname the name of the StarTeam project to be acted on
See Also: setURL
Parameters: servername a String
value
See Also: setURL
Parameters: serverport port number to be set
See Also: setURL
Parameters: url a String
of the form
"servername:portnum/project/view"
See Also: setServername setServerport setProjectname setViewname
Parameters: userName name of the user to be logged in
Parameters: viewname the name of the StarTeam view to be acted on
See Also: setURL