Class CCMkattr
- 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.CCMkattr
 
 
 
 
- 
- All Implemented Interfaces:
- java.lang.Cloneable
 
 public class CCMkattr extends ClearCase Task to perform mkattr command to ClearCase.The following attributes are interpreted: Task attributes Attribute Values Required viewpath Path to the ClearCase view file or directory that the command will operate on Yes replace Replace the value of the attribute if it already exists No recurse Process each subdirectory under viewpath No version Identify a specific version to attach the attribute to No typename Name of the attribute type Yes typevalue Value to attach to the attribute type Yes 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 SummaryFields Modifier and Type Field Description static java.lang.StringFLAG_COMMENT-c flag -- comment to attach to the elementstatic java.lang.StringFLAG_COMMENTFILE-cfile flag -- file containing a comment to attach to the filestatic java.lang.StringFLAG_NOCOMMENT-nc flag -- no comment is specifiedstatic java.lang.StringFLAG_RECURSE-recurse flag -- process all subdirectoriesstatic java.lang.StringFLAG_REPLACE-replace flag -- replace the existing value of the attributestatic java.lang.StringFLAG_VERSION-version flag -- attach attribute to specified version- 
Fields 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_UPDATE
 - 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description CCMkattr()
 - 
Method SummaryModifier and Type Method Description voidexecute()Executes the task.java.lang.StringgetComment()Get comment stringjava.lang.StringgetCommentFile()Get comment filebooleangetRecurse()Get recurse flag statusbooleangetReplace()Get replace flag statusjava.lang.StringgetTypeName()Get attribute type-namejava.lang.StringgetTypeValue()Get the attribute type-valuejava.lang.StringgetVersion()Get version flag statusvoidsetComment(java.lang.String comment)Set comment stringvoidsetCommentFile(java.lang.String cfile)Set comment filevoidsetRecurse(boolean recurse)Set recurse flagvoidsetReplace(boolean replace)Set the replace flagvoidsetTypeName(java.lang.String tn)Set the attribute type-namevoidsetTypeValue(java.lang.String tv)Set the attribute type-valuevoidsetVersion(java.lang.String version)Set the version flag- 
Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCasegetClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath
 - 
Methods 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, setTaskType
 - 
Methods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
- 
 
- 
- 
- 
Field Detail- 
FLAG_REPLACEpublic static final java.lang.String FLAG_REPLACE -replace flag -- replace the existing value of the attribute- See Also:
- Constant Field Values
 
 - 
FLAG_RECURSEpublic static final java.lang.String FLAG_RECURSE -recurse flag -- process all subdirectories- See Also:
- Constant Field Values
 
 - 
FLAG_VERSIONpublic static final java.lang.String FLAG_VERSION -version flag -- attach attribute to specified version- See Also:
- Constant Field Values
 
 - 
FLAG_COMMENTpublic static final java.lang.String FLAG_COMMENT -c flag -- comment to attach to the element- See Also:
- Constant Field Values
 
 - 
FLAG_COMMENTFILEpublic static final java.lang.String FLAG_COMMENTFILE -cfile flag -- file containing a comment to attach to the file- See Also:
- Constant Field Values
 
 - 
FLAG_NOCOMMENTpublic static final java.lang.String FLAG_NOCOMMENT -nc flag -- no comment is specified- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
executepublic void execute() throws BuildExceptionExecutes 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
 
 - 
setVersionpublic void setVersion(java.lang.String version) Set the version flag- Parameters:
- version- the status to set the flag to
 
 - 
getVersionpublic java.lang.String getVersion() Get version flag status- Returns:
- boolean containing status of version flag
 
 - 
setCommentpublic void setComment(java.lang.String comment) Set comment string- Parameters:
- comment- the comment string
 
 - 
getCommentpublic java.lang.String getComment() Get comment string- Returns:
- String containing the comment
 
 - 
setCommentFilepublic void setCommentFile(java.lang.String cfile) Set comment file- Parameters:
- cfile- the path to the comment file
 
 - 
getCommentFilepublic java.lang.String getCommentFile() Get comment file- Returns:
- String containing the path to the comment file
 
 - 
setTypeNamepublic void setTypeName(java.lang.String tn) Set the attribute type-name- Parameters:
- tn- the type name
 
 - 
getTypeNamepublic java.lang.String getTypeName() Get attribute type-name- Returns:
- String containing type name
 
 - 
setTypeValuepublic void setTypeValue(java.lang.String tv) Set the attribute type-value- Parameters:
- tv- the type value
 
 - 
getTypeValuepublic java.lang.String getTypeValue() Get the attribute type-value- Returns:
- String containing type value
 
 
- 
 
-