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

Class StarTeamLabel

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

UNKNOWN: name="stlabel" category="scm"

Method Summary
protected ViewcreateSnapshotView(View raw)
Override of base-class abstract function creates an appropriately configured view.
voidexecute()
This method does the work of creating the new view and checking it into Starteam.
voidsetBuildLabel(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.
voidsetDescription(String description)
Description of the label to be stored in the StarTeam project.
voidsetLabel(String label)
The name to be given to the label; required.
voidsetLastBuild(String lastbuild)
The timestamp of the build that will be stored with the label; required.
voidsetRevisionLabel(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.

Method Detail

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.

Parameters: raw the unconfigured View

Returns: the snapshot View appropriately configured.

execute

public void execute()
This method does the work of creating the new view and checking it into Starteam.

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.

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)
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