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

Class CCMklbtype

Implemented Interfaces:
Cloneable

public class CCMklbtype
extends ClearCase

Task to perform mklbtype command to ClearCase.

The following attributes are interpreted:

AttributeValuesRequired
typenameName of the label type to createYes
vobName of the VOBNo
replaceReplace an existing label definition of the same typeNo
globalEither global or ordinary can be specified, not both. Creates a label type that is global to the VOB or to VOBs that use this VOBNo
ordinaryEither global or ordinary can be specified, not both. Creates a label type that can be used only in the current VOB. DefaultNo
pbranchAllows the label type to be used once per branch in a given element's version treeNo
sharedSets the way mastership is checked by ClearCase. See ClearCase documentation for detailsNo
commentSpecify a comment. Only one of comment or cfile may be used.No
commentfileSpecify a file containing a comment. Only one of comment or cfile may be used.No
failonerrThrow an exception if the command fails. Default is trueNo

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_GLOBAL
-global flag -- creates a label type that is global to the VOB or to VOBs that use this VOB
static String
FLAG_NOCOMMENT
-nc flag -- no comment is specified
static String
FLAG_ORDINARY
-ordinary flag -- creates a label type that can be used only in the current VOB
static String
FLAG_PBRANCH
-pbranch flag -- allows label type to be used once per branch
static String
FLAG_REPLACE
-replace flag -- replace existing label definition of the same type
static String
FLAG_SHARED
-shared flag -- sets the way mastership is checked by ClearCase

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

target, taskName, taskType, wrapper

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

description, location, project

Method Summary

void
execute()
Executes the task.
String
getComment()
Get comment string
String
getCommentFile()
Get comment file
boolean
getGlobal()
Get global flag status
boolean
getOrdinary()
Get ordinary flag status
boolean
getPbranch()
Get pbranch flag status
boolean
getReplace()
Get replace flag status
boolean
getShared()
Get shared flag status
String
getTypeName()
Get type-name string
String
getVOB()
Get VOB name
void
setComment(String comment)
Set comment string
void
setCommentFile(String cfile)
Set comment file
void
setGlobal(boolean glob)
Set the global flag
void
setOrdinary(boolean ordinary)
Set the ordinary flag
void
setPbranch(boolean pbranch)
Set the pbranch flag
void
setReplace(boolean repl)
Set the replace flag
void
setShared(boolean shared)
Set the shared flag
void
setTypeName(String tn)
Set type-name string
void
setVOB(String vob)
Set the VOB name

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

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

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_GLOBAL

public static final String FLAG_GLOBAL
-global flag -- creates a label type that is global to the VOB or to VOBs that use this VOB

FLAG_NOCOMMENT

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

FLAG_ORDINARY

public static final String FLAG_ORDINARY
-ordinary flag -- creates a label type that can be used only in the current VOB

FLAG_PBRANCH

public static final String FLAG_PBRANCH
-pbranch flag -- allows label type to be used once per branch

FLAG_REPLACE

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

FLAG_SHARED

public static final String FLAG_SHARED
-shared flag -- sets the way mastership is checked by ClearCase

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

getGlobal

public boolean getGlobal()
Get global flag status
Returns:
boolean containing status of global flag

getOrdinary

public boolean getOrdinary()
Get ordinary flag status
Returns:
boolean containing status of ordinary flag

getPbranch

public boolean getPbranch()
Get pbranch flag status
Returns:
boolean containing status of pbranch flag

getReplace

public boolean getReplace()
Get replace flag status
Returns:
boolean containing status of replace flag

getShared

public boolean getShared()
Get shared flag status
Returns:
boolean containing status of shared flag

getTypeName

public String getTypeName()
Get type-name string
Returns:
String containing the type-name

getVOB

public String getVOB()
Get VOB name
Returns:
String containing VOB name

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

setGlobal

public void setGlobal(boolean glob)
Set the global flag
Parameters:
glob - the status to set the flag to

setOrdinary

public void setOrdinary(boolean ordinary)
Set the ordinary flag
Parameters:
ordinary - the status to set the flag to

setPbranch

public void setPbranch(boolean pbranch)
Set the pbranch flag
Parameters:
pbranch - the status to set the flag to

setReplace

public void setReplace(boolean repl)
Set the replace flag
Parameters:
repl - the status to set the flag to

setShared

public void setShared(boolean shared)
Set the shared flag
Parameters:
shared - the status to set the flag to

setTypeName

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

setVOB

public void setVOB(String vob)
Set the VOB name
Parameters:
vob - the VOB name