org.apache.tools.ant.taskdefs.optional.starteam

Class StarTeamLabel

Implemented Interfaces:
Cloneable

public class StarTeamLabel
extends StarTeamTask

Creates a view label in StarTeam at the specified view. Ant Usage:
 <taskdef name="stlabel"
          classname="org.apache.tools.ant.taskdefs.optional.starteam.StarTeamLabel"/<
     <stlabel
 label="1.0" lastbuild="20011514100000" description="Successful Build"
 username="BuildMaster" password="ant"
 starteamurl="server:port/project/view"/>
 
See Also:
borland StarTeam Web Site

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Method Summary

protected View
createSnapshotView(View raw)
Override of base-class abstract function creates an appropriately configured view.
void
execute()
This method does the work of creating the new view and checking it into Starteam.
void
setBuildLabel(boolean buildlabel)
set the type of label based on the supplied value - if true, this label will be a revision label, if false, a build label.
void
setDescription(String description)
Description of the label to be stored in the StarTeam project.
void
setLabel(String label)
The name to be given to the label; required.
void
setLastBuild(String lastbuild)
The timestamp of the build that will be stored with the label; required.
void
setRevisionLabel(boolean revisionlabel)
set the type of label based on the supplied value - if true, this label will be a revision label, if false, a build label.

Methods inherited from class org.apache.tools.ant.taskdefs.optional.starteam.StarTeamTask

createSnapshotView, disconnectFromServer, getPassword, getProjectname, getServer, getServername, getServerport, getTypeNames, getURL, getUserName, getUserName, getViewURL, getViewname, openView, setPassword, setProjectname, setServername, setServerport, setURL, setUserName, setViewname

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Method Details

createSnapshotView

protected View createSnapshotView(View raw)
Override of base-class abstract function creates an appropriately configured view. For labels this a view configured as of this.lastBuild.
Overrides:
createSnapshotView in interface StarTeamTask
Parameters:
raw - the unconfigured View
Returns:
the snapshot View appropriately configured.

execute

public void execute()
            throws BuildException
This method does the work of creating the new view and checking it into Starteam.
Overrides:
execute in interface Task
Throws:
BuildException - on error

setBuildLabel

public void setBuildLabel(boolean buildlabel)
set the type of label based on the supplied value - if true, this label will be a revision label, if false, a build label.
Parameters:
buildlabel - If true this will be a revision label; if false, a build label

setDescription

public void setDescription(String description)
Description of the label to be stored in the StarTeam project.
Overrides:
setDescription in interface ProjectComponent
Parameters:
description - the description to be used

setLabel

public void setLabel(String label)
The name to be given to the label; required.
Parameters:
label - the name to be used

setLastBuild

public void setLastBuild(String lastbuild)
            throws BuildException
The timestamp of the build that will be stored with the label; required. Must be formatted yyyyMMddHHmmss
Parameters:
lastbuild - the timestamp of the last build
Throws:
BuildException - on error

setRevisionLabel

public void setRevisionLabel(boolean revisionlabel)
set the type of label based on the supplied value - if true, this label will be a revision label, if false, a build label.
Parameters:
revisionlabel - If true this will be a revision label; if false, a build label