Class CCCheckout
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.CCCheckout
- All Implemented Interfaces:
- Cloneable
Performs ClearCase checkout.
 
   
The following attributes are interpreted:
| Attribute | Values | Required | 
|---|---|---|
| viewpath | Path to the ClearCase view file or directory that the command will operate on | No | 
| reserved | Specifies whether to check out the file as reserved or not | Yes | 
| out | Creates a writable file under a different filename | No | 
| nodata | Checks out the file but does not create an editable file containing its data | No | 
| branch | Specify a branch to check out the file to | No | 
| version | Allows checkout of a version other than main latest | No | 
| nowarn | Suppress warning messages | 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 | 
| notco | Fail if it's already checked out to the current view. Set to false to ignore it. | No | 
| failonerr | Throw an exception if the command fails. Default is true | No | 
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final String-branch flag -- checks out the file on a specified branchstatic 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-ndata flag -- checks out the file but does not create an editable file containing its datastatic final String-nwarn flag -- suppresses warning messagesstatic final String-out flag -- create a writable file under a different filenamestatic final String-reserved flag -- check out the file as reservedstatic final String-reserved flag -- check out the file as unreservedstatic final String-version flag -- allows checkout of a version that is not main latestFields 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 branch nameGet comment stringGet comment filebooleanGet nodata flag statusbooleangetNotco()Get notco flag statusbooleanGet nowarn flag statusgetOut()Get out filebooleanGet reserved flag statusbooleanGet version flag statusvoidSpecify a branch to check out the file to.voidsetComment(String comment) Sets the comment string.voidsetCommentFile(String cfile) Specifies a file containing a comment.voidsetNoData(boolean ndata) If true, checks out the file but does not create an editable file containing its data.voidsetNotco(boolean notco) If true, checkout fails if the element is already checked out to the current view.voidsetNoWarn(boolean nwarn) If true, warning messages are suppressed.voidCreates a writable file under a different filename.voidsetReserved(boolean reserved) If true, checks out the file as reserved.voidsetVersion(boolean version) If true, allows checkout of a version other than main latest.Methods 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_RESERVED-reserved flag -- check out the file as reserved- See Also:
 
- 
FLAG_UNRESERVED-reserved flag -- check out the file as unreserved- See Also:
 
- 
FLAG_OUT-out flag -- create a writable file under a different filename- See Also:
 
- 
FLAG_NODATA-ndata flag -- checks out the file but does not create an editable file containing its data- See Also:
 
- 
FLAG_BRANCH-branch flag -- checks out the file on a specified branch- See Also:
 
- 
FLAG_VERSION-version flag -- allows checkout of a version that is not main latest- See Also:
 
- 
FLAG_NOWARN-nwarn flag -- suppresses warning messages- 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- 
CCCheckoutpublic CCCheckout()
 
- 
- 
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
 
- 
setReservedpublic void setReserved(boolean reserved) If true, checks out the file as reserved.- Parameters:
- reserved- the status to set the flag to
 
- 
getReservedpublic boolean getReserved()Get reserved flag status- Returns:
- boolean containing status of reserved flag
 
- 
setNotcopublic void setNotco(boolean notco) If true, checkout fails if the element is already checked out to the current view.- Parameters:
- notco- the status to set the flag to
- Since:
- ant 1.6.1
 
- 
getNotcopublic boolean getNotco()Get notco flag status- Returns:
- boolean containing status of notco flag
- Since:
- ant 1.6.1
 
- 
setOutCreates a writable file under a different filename.- Parameters:
- outf- the path to the out file
 
- 
getOutGet out file- Returns:
- String containing the path to the out file
 
- 
setNoDatapublic void setNoData(boolean ndata) If true, checks out the file but does not create an editable file containing its data.- Parameters:
- ndata- the status to set the flag to
 
- 
getNoDatapublic boolean getNoData()Get nodata flag status- Returns:
- boolean containing status of ndata flag
 
- 
setBranchSpecify a branch to check out the file to.- Parameters:
- branch- the name of the branch
 
- 
getBranchGet branch name- Returns:
- String containing the name of the branch
 
- 
setVersionpublic void setVersion(boolean version) If true, allows checkout of a version other than main latest.- Parameters:
- version- the status to set the flag to
 
- 
getVersionpublic boolean getVersion()Get version flag status- Returns:
- boolean containing status of version flag
 
- 
setNoWarnpublic void setNoWarn(boolean nwarn) If true, warning messages are suppressed.- Parameters:
- nwarn- the status to set the flag to
 
- 
getNoWarnpublic boolean getNoWarn()Get nowarn flag status- Returns:
- boolean containing status of nwarn flag
 
- 
setCommentSets the comment string.- Parameters:
- comment- the comment string
 
- 
getCommentGet comment string- Returns:
- String containing the comment
 
- 
setCommentFileSpecifies a file containing a comment.- Parameters:
- cfile- the path to the comment file
 
- 
getCommentFileGet comment file- Returns:
- String containing the path to the comment file
 
 
-