Class CCMklabel
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel
- All Implemented Interfaces:
- Cloneable
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 SummaryFieldsModifier and TypeFieldDescriptionstatic final String-c flag -- comment to attach to the filestatic final String-cfile flag -- file containing a comment to attach to the filestatic final String-nc flag -- no comment is specifiedstatic final String-recurse flag -- process all subdirectoriesstatic final String-replace flag -- replace another label of the same typestatic final String-version flag -- attach label to specified versionFields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCaseCOMMAND_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_UPDATEFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidexecute()Executes the task.Get comment stringGet comment filebooleanGet recurse flag statusbooleanGet replace flag statusGet type-nameGet version flag statusgetVOB()Get VOB namevoidsetComment(String comment) Set comment stringvoidsetCommentFile(String cfile) Set comment filevoidsetRecurse(boolean recurse) Set recurse flagvoidsetReplace(boolean replace) Set the replace flagvoidsetTypeName(String tn) Set the type-namevoidsetVersion(String version) Set the version flagvoidSet the VOB nameMethods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCasegetClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPathMethods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
- 
Field Details- 
FLAG_REPLACE-replace flag -- replace another label of the same type- See Also:
 
- 
FLAG_RECURSE-recurse flag -- process all subdirectories- See Also:
 
- 
FLAG_VERSION-version flag -- attach label to specified version- See Also:
 
- 
FLAG_COMMENT-c flag -- comment to attach to the file- See Also:
 
- 
FLAG_COMMENTFILE-cfile flag -- file containing a comment to attach to the file- See Also:
 
- 
FLAG_NOCOMMENT-nc flag -- no comment is specified- See Also:
 
 
- 
- 
Constructor Details- 
CCMklabelpublic CCMklabel()
 
- 
- 
Method Details- 
executeExecutes the task.Builds a command line to execute cleartool and then calls Exec's run method to execute the command line. - Overrides:
- executein class- Task
- Throws:
- BuildException- if the command fails and failonerr is set to true
 
- 
setReplacepublic void setReplace(boolean replace) Set the replace flag- Parameters:
- replace- the status to set the flag to
 
- 
getReplacepublic boolean getReplace()Get replace flag status- Returns:
- boolean containing status of replace flag
 
- 
setRecursepublic void setRecurse(boolean recurse) Set recurse flag- Parameters:
- recurse- the status to set the flag to
 
- 
getRecursepublic boolean getRecurse()Get recurse flag status- Returns:
- boolean containing status of recurse flag
 
- 
setVersionSet the version flag- Parameters:
- version- the status to set the flag to
 
- 
getVersionGet version flag status- Returns:
- boolean containing status of version flag
 
- 
setCommentSet comment string- Parameters:
- comment- the comment string
 
- 
getCommentGet comment string- Returns:
- String containing the comment
 
- 
setCommentFileSet comment file- Parameters:
- cfile- the path to the comment file
 
- 
getCommentFileGet comment file- Returns:
- String containing the path to the comment file
 
- 
setTypeNameSet the type-name- Parameters:
- tn- the type name
 
- 
getTypeNameGet type-name- Returns:
- String containing type name
 
- 
setVOBSet the VOB name- Parameters:
- vob- the VOB name
 
- 
getVOBGet VOB name- Returns:
- String containing VOB name
 
 
-