org.apache.tools.ant.taskdefs.optional.clearcase

Class CCMklabel


public class CCMklabel
extends ClearCase

Task to perform mklabel command to ClearCase.

The following attributes are interpreted:

Attribute Values Required
viewpath Path to the ClearCase view file or directory that the command will operate on No
replace Replace a label of the same type on the same branch No
recurse Process each subdirectory under viewpath No
version Identify a specific version to attach the label to No
typename Name of the label type Yes
vob Name of the VOB No
comment Specify a comment. Only one of comment or cfile may be used. No
commentfile Specify a file containing a comment. Only one of comment or cfile may be used. No
failonerr Throw an exception if the command fails. Default is true No

Field Summary

static String
FLAG_COMMENT
-c flag -- comment to attach to the file
static String
FLAG_COMMENTFILE
-cfile flag -- file containing a comment to attach to the file
static String
FLAG_NOCOMMENT
-nc flag -- no comment is specified
static String
FLAG_RECURSE
-recurse flag -- process all subdirectories
static String
FLAG_REPLACE
-replace flag -- replace another label of the same type
static String
FLAG_VERSION
-version flag -- attach label to specified version

Fields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase

COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_LOCK, COMMAND_LSCO, COMMAND_MKATTR, COMMAND_MKBL, COMMAND_MKDIR, COMMAND_MKELEM, COMMAND_MKLABEL, COMMAND_MKLBTYPE, COMMAND_RMTYPE, COMMAND_UNCHECKOUT, COMMAND_UNLOCK, COMMAND_UPDATE

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

Method Summary

void
execute()
Executes the task.
String
getComment()
Get comment string
String
getCommentFile()
Get comment file
boolean
getRecurse()
Get recurse flag status
boolean
getReplace()
Get replace flag status
String
getTypeName()
Get type-name
String
getVOB()
Get VOB name
String
getVersion()
Get version flag status
void
setComment(String comment)
Set comment string
void
setCommentFile(String cfile)
Set comment file
void
setRecurse(boolean recurse)
Set recurse flag
void
setReplace(boolean replace)
Set the replace flag
void
setTypeName(String tn)
Set the type-name
void
setVOB(String vob)
Set the VOB name
void
setVersion(String version)
Set the version flag

Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase

getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath

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

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

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

getProject, log, log, setProject

Field Details

FLAG_COMMENT

public static final String FLAG_COMMENT
-c flag -- comment to attach to the file


FLAG_COMMENTFILE

public static final String FLAG_COMMENTFILE
-cfile flag -- file containing a comment to attach to the file


FLAG_NOCOMMENT

public static final String FLAG_NOCOMMENT
-nc flag -- no comment is specified


FLAG_RECURSE

public static final String FLAG_RECURSE
-recurse flag -- process all subdirectories


FLAG_REPLACE

public static final String FLAG_REPLACE
-replace flag -- replace another label of the same type


FLAG_VERSION

public static final String FLAG_VERSION
-version flag -- attach label to specified version

Method Details

execute

public void execute()
            throws BuildException
Executes the task.

Builds a command line to execute cleartool and then calls Exec's run method to execute the command line.

Overrides:
execute in interface Task

Throws:
BuildException - if the command fails and failonerr is set to true


getComment

public String getComment()
Get comment string

Returns:
String containing the comment


getCommentFile

public String getCommentFile()
Get comment file

Returns:
String containing the path to the comment file


getRecurse

public boolean getRecurse()
Get recurse flag status

Returns:
boolean containing status of recurse flag


getReplace

public boolean getReplace()
Get replace flag status

Returns:
boolean containing status of replace flag


getTypeName

public String getTypeName()
Get type-name

Returns:
String containing type name


getVOB

public String getVOB()
Get VOB name

Returns:
String containing VOB name


getVersion

public String getVersion()
Get version flag status

Returns:
boolean containing status of version flag


setComment

public void setComment(String comment)
Set comment string

Parameters:
comment - the comment string


setCommentFile

public void setCommentFile(String cfile)
Set comment file

Parameters:
cfile - the path to the comment file


setRecurse

public void setRecurse(boolean recurse)
Set recurse flag

Parameters:
recurse - the status to set the flag to


setReplace

public void setReplace(boolean replace)
Set the replace flag

Parameters:
replace - the status to set the flag to


setTypeName

public void setTypeName(String tn)
Set the type-name

Parameters:
tn - the type name


setVOB

public void setVOB(String vob)
Set the VOB name

Parameters:
vob - the VOB name


setVersion

public void setVersion(String version)
Set the version flag

Parameters:
version - the status to set the flag to


Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.