Class ClearCase
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
- All Implemented Interfaces:
- Cloneable
- Direct Known Subclasses:
- CCCheckin,- CCCheckout,- CCLock,- CCMkattr,- CCMkbl,- CCMkdir,- CCMkelem,- CCMklabel,- CCMklbtype,- CCRmtype,- CCUnCheckout,- CCUnlock,- CCUpdate
A base class for creating tasks for executing commands on ClearCase.
 
By default the task expects the cleartool executable to be in the path, you can override this be specifying the cleartooldir attribute.
This class provides set and get methods for the 'viewpath' and 'objselect' attribute. It also contains constants for the flags that can be passed to cleartool.
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final StringThe 'Checkin' commandstatic final StringThe 'Checkout' commandstatic final StringThe 'Lock' commandstatic final StringThe 'LsCheckout' commandstatic final StringThe 'Mkattr' commandstatic final StringThe 'Mkbl' commandstatic final StringThe 'Mkdir' commandstatic final StringThe 'Mkelem' commandstatic final StringThe 'Mklabel' commandstatic final StringThe 'Mklbtype' commandstatic final StringThe 'Rmtype' commandstatic final StringThe 'UndoCheckout' commandstatic final StringThe 'Unlock' commandstatic final StringThe 'Update' commandFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected final StringBuilds and returns the command string to execute cleartoolbooleanGet failonerr flag statusGet the object to operate onGet the path to the item in a clearcase viewGet the basename path of the item in a clearcase viewprotected intrun(Commandline cmd) Execute the given command are return success or failureprotected StringrunS(Commandline cmdline) Deprecated.use the two arg version insteadprotected StringrunS(Commandline cmdline, boolean failOnError) Execute the given command, and return it's outputfinal voidsetClearToolDir(String dir) Set the directory where the cleartool executable is located.voidsetFailOnErr(boolean failonerr) If true, command will throw an exception on failure.final voidsetObjSelect(String objSelect) Set the object to operate on.final voidsetViewPath(String viewPath) Set the path to the item in a ClearCase view to operate on.Methods inherited from class org.apache.tools.ant.TaskbindToOwner, execute, 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- 
COMMAND_UPDATE
- 
COMMAND_CHECKOUT
- 
COMMAND_CHECKIN
- 
COMMAND_UNCHECKOUT
- 
COMMAND_LOCK
- 
COMMAND_UNLOCK
- 
COMMAND_MKBL
- 
COMMAND_MKLABEL
- 
COMMAND_MKLBTYPE
- 
COMMAND_RMTYPE
- 
COMMAND_LSCO
- 
COMMAND_MKELEM
- 
COMMAND_MKATTR
- 
COMMAND_MKDIR
 
- 
- 
Constructor Details- 
ClearCasepublic ClearCase()
 
- 
- 
Method Details- 
setClearToolDirSet the directory where the cleartool executable is located.- Parameters:
- dir- the directory containing the cleartool executable
 
- 
getClearToolCommandBuilds and returns the command string to execute cleartool- Returns:
- String containing path to the executable
 
- 
setViewPathSet the path to the item in a ClearCase view to operate on.- Parameters:
- viewPath- Path to the view directory or file
 
- 
getViewPath
- 
getViewPathBasenameGet the basename path of the item in a clearcase view- Returns:
- basename
 
- 
setObjSelectSet the object to operate on.- Parameters:
- objSelect- object to operate on
 
- 
getObjSelect
- 
runExecute the given command are return success or failure- Parameters:
- cmd- command line to execute
- Returns:
- the exit status of the subprocess or INVALID
 
- 
runSDeprecated.use the two arg version insteadExecute the given command, and return it's output- Parameters:
- cmdline- command line to execute
- Returns:
- output of the command line
 
- 
runSExecute the given command, and return it's output- Parameters:
- cmdline- command line to execute
- failOnError- whether to fail the build if the command fails
- Returns:
- output of the command line
- Since:
- Ant 1.10.6
 
- 
setFailOnErrpublic void setFailOnErr(boolean failonerr) If true, command will throw an exception on failure.- Parameters:
- failonerr- the status to set the flag to
- Since:
- ant 1.6.1
 
- 
getFailOnErrpublic boolean getFailOnErr()Get failonerr flag status- Returns:
- boolean containing status of failonerr flag
- Since:
- ant 1.6.1
 
 
-