|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.tools.ant.ProjectComponent | +--org.apache.tools.ant.Task | +--org.apache.tools.ant.taskdefs.optional.starteam.StarTeamTask
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.
TreeBasedTask
Field Summary |
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 |
Constructor Summary | |
StarTeamTask()
|
Method Summary | |
protected abstract com.starbase.starteam.View |
createSnapshotView(com.starbase.starteam.View rawview)
Derived classes must override createSnapshotView
defining the kind of configured view appropriate to its task. |
java.lang.String |
getPassword()
returns the password used for login |
java.lang.String |
getProjectname()
returns the name of the StarTeam project to be acted on |
protected com.starbase.starteam.Server |
getServer()
returns a reference to the server which may be used for informational purposes by subclasses. |
java.lang.String |
getServername()
returns the name of the StarTeamServer |
java.lang.String |
getServerport()
returns the port number of the StarTeam connection |
java.lang.String |
getURL()
a convenience method which returns the whole StarTeam connection information as a single URL string of |
java.lang.String |
getUserName()
returns the name of the StarTeam user |
protected java.lang.String |
getUserName(int userID)
Returns the name of the user with the supplied ID or a blank string if user not found. |
java.lang.String |
getViewname()
returns the name of the StarTeam view to be acted on |
protected com.starbase.starteam.View |
openView()
All subclasses will call on this method to open the view needed for processing. |
void |
setPassword(java.lang.String password)
set the password to be used for login; required. |
void |
setProjectname(java.lang.String projectname)
set the name of the StarTeam project to be acted on; required if URL is not set. |
void |
setServername(java.lang.String servername)
Set the name of StarTeamServer; required if URL is not set. |
void |
setServerport(java.lang.String serverport)
set the port number of the StarTeam connection; required if URL is not set. |
void |
setURL(java.lang.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(java.lang.String userName)
set the name of the StarTeam user, needed for the connection |
void |
setViewname(java.lang.String viewname)
set the name of the StarTeam view to be acted on; required if URL is not set. |
Methods inherited from class org.apache.tools.ant.Task |
execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
getProject, setProject |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public StarTeamTask()
Method Detail |
public void setServername(java.lang.String servername)
servername
- a String
valuesetURL(String)
public java.lang.String getServername()
getURL()
public void setServerport(java.lang.String serverport)
serverport
- port number to be setsetURL(String)
public java.lang.String getServerport()
getURL()
public void setProjectname(java.lang.String projectname)
projectname
- the name of the StarTeam project to be acted onsetURL(String)
public java.lang.String getProjectname()
getURL()
public void setViewname(java.lang.String viewname)
setURL(String)
public java.lang.String getViewname()
getURL()
public void setURL(java.lang.String url)
url
- a String
of the form
"servername:portnum/project/view"setServername(String)
,
setServerport(String)
,
setProjectname(String)
,
setViewname(String)
public java.lang.String getURL()
String
of the form
"servername:portnum/project/view"getServername()
,
getServerport()
,
getProjectname()
,
getViewname()
public void setUserName(java.lang.String userName)
userName
- name of the user to be logged inpublic java.lang.String getUserName()
public void setPassword(java.lang.String password)
password
- the password to be used for loginpublic java.lang.String getPassword()
protected com.starbase.starteam.Server getServer()
protected abstract com.starbase.starteam.View createSnapshotView(com.starbase.starteam.View rawview)
createSnapshotView
defining the kind of configured view appropriate to its task.
rawview
- the unconfigured View
View
appropriately configured.protected com.starbase.starteam.View openView() throws BuildException
Server
that may be accessed for information at various
points in the process.
View
that will be used for processing.
BuildException
createSnapshotView(View)
,
getServer()
protected java.lang.String getUserName(int userID)
userID
- a user's ID
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |