| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
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
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 Summary | |
| static java.lang.String | FLAG_COMMENT-c flag -- comment to attach to the file | 
| static java.lang.String | FLAG_COMMENTFILE-cfile flag -- file containing a comment to attach to the file | 
| static java.lang.String | FLAG_IDENTICAL-identical flag -- allows the file to be checked in even if it is identical to the original | 
| static java.lang.String | FLAG_KEEPCOPY-keep flag -- keeps a copy of the file with a .keep extension | 
| static java.lang.String | FLAG_NOCOMMENT-nc flag -- no comment is specified | 
| static java.lang.String | FLAG_NOWARN-nwarn flag -- suppresses warning messages | 
| static java.lang.String | FLAG_PRESERVETIME-ptime flag -- preserves the modification time | 
| 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 | 
| description, location, target, taskName, taskType, wrapper | 
| Fields inherited from class org.apache.tools.ant.ProjectComponent | 
| project | 
| Constructor Summary | |
| CCCheckin() | |
| Method Summary | |
|  void | execute()Executes the task. | 
|  java.lang.String | getComment()Get comment string | 
|  java.lang.String | getCommentFile()Get comment file | 
|  boolean | getIdentical()Get identical flag status | 
|  boolean | getKeepCopy()Get keepcopy flag status | 
|  boolean | getNoWarn()Get nowarn flag status | 
|  boolean | getPreserveTime()Get preservetime flag status | 
|  void | setComment(java.lang.String comment)Sets the comment string. | 
|  void | setCommentFile(java.lang.String cfile)Specifies a file containing a comment. | 
|  void | setIdentical(boolean identical)If true, allows the file to be checked in even if it is identical to the original. | 
|  void | setKeepCopy(boolean keep)If true, keeps a copy of the file with a .keep extension. | 
|  void | setNoWarn(boolean nwarn)If true, suppress warning messages. | 
|  void | setPreserveTime(boolean ptime)If true, preserve the modification time. | 
| 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 | 
| getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType | 
| Methods inherited from class org.apache.tools.ant.ProjectComponent | 
| getProject, setProject | 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
public static final java.lang.String FLAG_COMMENT
public static final java.lang.String FLAG_COMMENTFILE
public static final java.lang.String FLAG_NOCOMMENT
public static final java.lang.String FLAG_NOWARN
public static final java.lang.String FLAG_PRESERVETIME
public static final java.lang.String FLAG_KEEPCOPY
public static final java.lang.String FLAG_IDENTICAL
| Constructor Detail | 
public CCCheckin()
| Method Detail | 
public void execute()
             throws BuildException
Builds a command line to execute cleartool and then calls Exec's run method to execute the command line.
execute in class TaskBuildException - if the command fails and failonerr is set to truepublic void setComment(java.lang.String comment)
comment - the comment stringpublic java.lang.String getComment()
public void setCommentFile(java.lang.String cfile)
cfile - the path to the comment filepublic java.lang.String getCommentFile()
public void setNoWarn(boolean nwarn)
nwarn - the status to set the flag topublic boolean getNoWarn()
public void setPreserveTime(boolean ptime)
ptime - the status to set the flag topublic boolean getPreserveTime()
public void setKeepCopy(boolean keep)
keep - the status to set the flag topublic boolean getKeepCopy()
public void setIdentical(boolean identical)
identical - the status to set the flag topublic boolean getIdentical()
| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||