StarTeamTask Apache Ant 1.7.1)

Methods

Hide/Show inherited methods

publicfinal void bindToOwner (Task owner) [Inherited From Task]

Bind a task to another; use this when configuring a newly created task to do work on behalf of another.

public java.lang.Object clone () throws java.lang.CloneNotSupportedException [Inherited From ProjectComponent]

protectedabstract View createSnapshotView (View rawview) throws BuildException

Derived classes must override createSnapshotView defining the kind of configured view appropriate to its task.

Derived classes must override createSnapshotView
defining the kind of configured view appropriate to its task.
Returns: the snapshot View appropriately configured.
Parameters:
- rawview - the unconfigured View
Throws:
- BuildException - on error

protectedfinal void disconnectFromServer ()

disconnects from the StarTeam server.

public void execute () throws BuildException [Inherited From Task]

Called by the project to let the task do its work.

public java.lang.String getDescription () [Inherited From ProjectComponent]

Returns the description of the current action.

Returns the description of the current action.
Returns: the description of the current action, or null if no description is available.

public Location getLocation () [Inherited From ProjectComponent]

Returns the file/location where this task was defined.

Returns the file/location where this task was defined.
Returns: the file/location where this task was defined. Should not return null. Location.UNKNOWN_LOCATION is used for unknown locations.
See Also: Location.UNKNOWN_LOCATION,

public Target getOwningTarget () [Inherited From Task]

Returns the container target of this task.

Returns the container target of this task.
Returns: The target containing this task, or null if this task is a top-level task.

publicfinal java.lang.String getPassword ()

returns the password used for login

public Project getProject () [Inherited From ProjectComponent]

Returns the project to which this component belongs.

publicfinal java.lang.String getProjectname ()

returns the name of the StarTeam project to be acted on

public RuntimeConfigurable getRuntimeConfigurableWrapper () [Inherited From Task]

Returns the wrapper used for runtime configuration.

protectedfinal Server getServer ()

returns a reference to the server which may be used for informational purposes by subclasses.

publicfinal java.lang.String getServername ()

returns the name of the StarTeamServer

publicfinal java.lang.String getServerport ()

returns the port number of the StarTeam connection

public java.lang.String getTaskName () [Inherited From Task]

Returns the name to use in logging messages.

public java.lang.String getTaskType () [Inherited From Task]

Return the type of task.

protectedfinal TypeNames getTypeNames ()

returns a list of TypeNames known to the server.

publicfinal java.lang.String getURL ()

a convenience method which returns the whole StarTeam connection information as a single URL string of

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

publicfinal java.lang.String getUserName ()

returns the name of the StarTeam user

protectedfinal java.lang.String getUserName (int userID)

Returns the name of the user with the supplied ID or a blank string if user not found.

publicfinal java.lang.String getViewname ()

returns the name of the StarTeam view to be acted on

protectedfinal java.lang.String getViewURL ()

returns an URL string useful for interacting with many StarTeamFinder methods.

protected RuntimeConfigurable getWrapper () [Inherited From Task]

Return the runtime configurable structure for this task.

protected void handleErrorFlush (java.lang.String output) [Inherited From Task]

Handles an error line by logging it with the WARN priority.

Handles an error line by logging it with the WARN priority.
Parameters:
- output - The error output to log. Should not be null.
Since: Ant 1.5.2

protected void handleErrorOutput (java.lang.String output) [Inherited From Task]

Handles an error output by logging it with the WARN priority.

Handles an error output by logging it with the WARN priority.
Parameters:
- output - The error output to log. Should not be null.

protected void handleFlush (java.lang.String output) [Inherited From Task]

Handles output by logging it with the INFO priority.

Handles output by logging it with the INFO priority.
Parameters:
- output - The output to log. Should not be null.
Since: Ant 1.5.2

protected int handleInput (byte[] buffer, int offset, int length) throws java.io.IOException [Inherited From Task]

Handle an input request by this task.

protected void handleOutput (java.lang.String output) [Inherited From Task]

Handles output by logging it with the INFO priority.

Handles output by logging it with the INFO priority.
Parameters:
- output - The output to log. Should not be null.

public void init () throws BuildException [Inherited From Task]

Called by the project to let the task initialize properly.

protectedfinal boolean isInvalid () [Inherited From Task]

Has this task been marked invalid?

public void log (java.lang.String msg) [Inherited From Task]

Logs a message with the default (INFO) priority.

Logs a message with the default (INFO) priority.
Parameters:
- msg - The message to be logged. Should not be null.

public void log (java.lang.String msg, int msgLevel) [Inherited From Task]

Logs a message with the given priority.

Logs a message with the given priority. This delegates
the actual logging to the project.
Parameters:
- msg - The message to be logged. Should not be null.
- msgLevel - The message priority at which this message is to be logged.

public void log (java.lang.String msg, java.lang.Throwable t, int msgLevel) [Inherited From Task]

Logs a message with the given priority.

Logs a message with the given priority. This delegates
the actual logging to the project.
Parameters:
- msg - The message to be logged. Should not be null.
- t - The exception to be logged. May be null.
- msgLevel - The message priority at which this message is to be logged.
Since: 1.7

public void log (java.lang.Throwable t, int msgLevel) [Inherited From Task]

Logs a message with the given priority.

Logs a message with the given priority. This delegates
the actual logging to the project.
Parameters:
- t - The exception to be logged. Should not be null.
- msgLevel - The message priority at which this message is to be logged.
Since: 1.7

public void maybeConfigure () throws BuildException [Inherited From Task]

Configures this task - if it hasn't been done already.

protected View openView () throws BuildException

All subclasses will call on this method to open the view needed for processing.

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.
Returns: the View that will be used for processing.
Throws:
- BuildException - on error
See Also: StarTeamTask.createSnapshotView(View), StarTeamTask.getServer(),

publicfinal void perform () [Inherited From Task]

Performs this task if it's still valid, or gets a replacement version and performs that otherwise.

public void reconfigure () [Inherited From Task]

Force the task to be reconfigured from its RuntimeConfigurable.

public void setDescription (java.lang.String desc) [Inherited From ProjectComponent]

Sets a description of the current action.

Sets a description of the current action. This may be used for logging
purposes.
Parameters:
- desc - Description of the current action. May be null, indicating that no description is available.

public void setLocation (Location location) [Inherited From ProjectComponent]

Sets the file/location where this task was defined.

Sets the file/location where this task was defined.
Parameters:
- location - The file/location where this task was defined. Should not be null--use Location.UNKNOWN_LOCATION if the location isn't known.
See Also: Location.UNKNOWN_LOCATION,

public void setOwningTarget (Target target) [Inherited From Task]

Sets the target container of this task.

Sets the target container of this task.
Parameters:
- target - Target in whose scope this task belongs. May be null, indicating a top-level task.

publicfinal void setPassword (java.lang.String password)

set the password to be used for login; required.

public void setProject (Project project) [Inherited From ProjectComponent]

Sets the project object of this component.

Sets the project object of this component. This method is used by
Project when a component is added to it so that the component has
access to the functions of the project. It should not be used
for any other purpose.
Parameters:
- project - Project in whose scope this component belongs. Must not be null.

publicfinal void setProjectname (java.lang.String projectname)

set the name of the StarTeam project to be acted on; required if URL is not set.

public void setRuntimeConfigurableWrapper (RuntimeConfigurable wrapper) [Inherited From Task]

Sets the wrapper to be used for runtime configuration.

Sets the wrapper to be used for runtime configuration.

This method should be used only by the ProjectHelper and Ant internals.
It is public to allow helper plugins to operate on tasks, normal tasks
should never use it.
Parameters:
- wrapper - The wrapper to be used for runtime configuration. May be null, in which case the next call to getRuntimeConfigurableWrapper will generate a new wrapper.

publicfinal void setServername (java.lang.String servername)

Set the name of StarTeamServer; required if URL is not set.

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

publicfinal void setServerport (java.lang.String serverport)

set the port number of the StarTeam connection; required if URL is not set.

public void setTaskName (java.lang.String name) [Inherited From Task]

Sets the name to use in logging messages.

Sets the name to use in logging messages.
Parameters:
- name - The name to use in logging messages. Should not be null.

public void setTaskType (java.lang.String type) [Inherited From Task]

Sets the name with which the task has been invoked.

Sets the name with which the task has been invoked.
Parameters:
- type - The name the task has been invoked as. Should not be null.

publicfinal 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.

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), StarTeamTask.setServerport(String), StarTeamTask.setProjectname(String), StarTeamTask.setViewname(String),

publicfinal void setUserName (java.lang.String userName)

set the name of the StarTeam user, needed for the connection

publicfinal void setViewname (java.lang.String viewname)

set the name of the StarTeam view to be acted on; required if URL is not set.