Class CCCheckin
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.CCCheckin
- All Implemented Interfaces:
- Cloneable
Performs ClearCase checkin.
 
   
The following attributes are interpreted:
| Attribute | Values | Required | 
|---|---|---|
| viewpath | Path to the ClearCase view file or directory that the command will operate on | 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 | 
| nowarn | Suppress warning messages | No | 
| preservetime | Preserve the modification time | No | 
| keepcopy | Keeps a copy of the file with a .keep extension | No | 
| identical | Allows the file to be checked in even if it is identical to the original | 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-identical flag -- allows the file to be checked in even if it is identical to the originalstatic final String-keep flag -- keeps a copy of the file with a .keep extensionstatic final String-nc flag -- no comment is specifiedstatic final String-nwarn flag -- suppresses warning messagesstatic final String-ptime flag -- preserves the modification timeFields 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 identical flag statusbooleanGet keepcopy flag statusbooleanGet nowarn flag statusbooleanGet preservetime flag statusvoidsetComment(String comment) Sets the comment string.voidsetCommentFile(String cfile) Specifies a file containing a comment.voidsetIdentical(boolean identical) If true, allows the file to be checked in even if it is identical to the original.voidsetKeepCopy(boolean keep) If true, keeps a copy of the file with a .keep extension.voidsetNoWarn(boolean nwarn) If true, suppress warning messages.voidsetPreserveTime(boolean ptime) If true, preserve the modification time.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_COMMENT
- 
FLAG_COMMENTFILE-cfile flag -- file containing a comment to attach to the file- See Also:
 
- 
FLAG_NOCOMMENT
- 
FLAG_NOWARN
- 
FLAG_PRESERVETIME-ptime flag -- preserves the modification time- See Also:
 
- 
FLAG_KEEPCOPY-keep flag -- keeps a copy of the file with a .keep extension- See Also:
 
- 
FLAG_IDENTICAL-identical flag -- allows the file to be checked in even if it is identical to the original- See Also:
 
 
- 
- 
Constructor Details- 
CCCheckinpublic CCCheckin()
 
- 
- 
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
 
- 
setCommentSets the comment string.- Parameters:
- comment- the comment string
 
- 
getComment
- 
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
 
- 
setNoWarnpublic void setNoWarn(boolean nwarn) If true, suppress warning messages.- Parameters:
- nwarn- the status to set the flag to
 
- 
getNoWarnpublic boolean getNoWarn()Get nowarn flag status- Returns:
- boolean containing status of nwarn flag
 
- 
setPreserveTimepublic void setPreserveTime(boolean ptime) If true, preserve the modification time.- Parameters:
- ptime- the status to set the flag to
 
- 
getPreserveTimepublic boolean getPreserveTime()Get preservetime flag status- Returns:
- boolean containing status of preservetime flag
 
- 
setKeepCopypublic void setKeepCopy(boolean keep) If true, keeps a copy of the file with a .keep extension.- Parameters:
- keep- the status to set the flag to
 
- 
getKeepCopypublic boolean getKeepCopy()Get keepcopy flag status- Returns:
- boolean containing status of keepcopy flag
 
- 
setIdenticalpublic void setIdentical(boolean identical) If true, allows the file to be checked in even if it is identical to the original.- Parameters:
- identical- the status to set the flag to
 
- 
getIdenticalpublic boolean getIdentical()Get identical flag status- Returns:
- boolean containing status of identical flag
 
 
-