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:
- java.lang.Cloneable
 - Direct Known Subclasses:
- CCCheckin,- CCCheckout,- CCLock,- CCMkattr,- CCMkbl,- CCMkdir,- CCMkelem,- CCMklabel,- CCMklbtype,- CCRmtype,- CCUnCheckout,- CCUnlock,- CCUpdate
 
 public abstract class ClearCase extends Task 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 SummaryFields Modifier and Type Field Description static java.lang.StringCOMMAND_CHECKINThe 'Checkin' commandstatic java.lang.StringCOMMAND_CHECKOUTThe 'Checkout' commandstatic java.lang.StringCOMMAND_LOCKThe 'Lock' commandstatic java.lang.StringCOMMAND_LSCOThe 'LsCheckout' commandstatic java.lang.StringCOMMAND_MKATTRThe 'Mkattr' commandstatic java.lang.StringCOMMAND_MKBLThe 'Mkbl' commandstatic java.lang.StringCOMMAND_MKDIRThe 'Mkdir' commandstatic java.lang.StringCOMMAND_MKELEMThe 'Mkelem' commandstatic java.lang.StringCOMMAND_MKLABELThe 'Mklabel' commandstatic java.lang.StringCOMMAND_MKLBTYPEThe 'Mklbtype' commandstatic java.lang.StringCOMMAND_RMTYPEThe 'Rmtype' commandstatic java.lang.StringCOMMAND_UNCHECKOUTThe 'UndoCheckout' commandstatic java.lang.StringCOMMAND_UNLOCKThe 'Unlock' commandstatic java.lang.StringCOMMAND_UPDATEThe 'Update' command- 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description ClearCase()
 - 
Method SummaryModifier and Type Method Description protected java.lang.StringgetClearToolCommand()Builds and returns the command string to execute cleartoolbooleangetFailOnErr()Get failonerr flag statusjava.lang.StringgetObjSelect()Get the object to operate onjava.lang.StringgetViewPath()Get the path to the item in a clearcase viewjava.lang.StringgetViewPathBasename()Get the basename path of the item in a clearcase viewprotected intrun(Commandline cmd)Execute the given command are return success or failureprotected java.lang.StringrunS(Commandline cmdline)Deprecated.use the two arg version insteadprotected java.lang.StringrunS(Commandline cmdline, boolean failOnError)Execute the given command, and return it's outputvoidsetClearToolDir(java.lang.String dir)Set the directory where the cleartool executable is located.voidsetFailOnErr(boolean failonerr)If true, command will throw an exception on failure.voidsetObjSelect(java.lang.String objSelect)Set the object to operate on.voidsetViewPath(java.lang.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, setTaskType
 - 
Methods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
- 
 
- 
- 
- 
Field Detail- 
COMMAND_UPDATEpublic static final java.lang.String COMMAND_UPDATE The 'Update' command- See Also:
- Constant Field Values
 
 - 
COMMAND_CHECKOUTpublic static final java.lang.String COMMAND_CHECKOUT The 'Checkout' command- See Also:
- Constant Field Values
 
 - 
COMMAND_CHECKINpublic static final java.lang.String COMMAND_CHECKIN The 'Checkin' command- See Also:
- Constant Field Values
 
 - 
COMMAND_UNCHECKOUTpublic static final java.lang.String COMMAND_UNCHECKOUT The 'UndoCheckout' command- See Also:
- Constant Field Values
 
 - 
COMMAND_LOCKpublic static final java.lang.String COMMAND_LOCK The 'Lock' command- See Also:
- Constant Field Values
 
 - 
COMMAND_UNLOCKpublic static final java.lang.String COMMAND_UNLOCK The 'Unlock' command- See Also:
- Constant Field Values
 
 - 
COMMAND_MKBLpublic static final java.lang.String COMMAND_MKBL The 'Mkbl' command- See Also:
- Constant Field Values
 
 - 
COMMAND_MKLABELpublic static final java.lang.String COMMAND_MKLABEL The 'Mklabel' command- See Also:
- Constant Field Values
 
 - 
COMMAND_MKLBTYPEpublic static final java.lang.String COMMAND_MKLBTYPE The 'Mklbtype' command- See Also:
- Constant Field Values
 
 - 
COMMAND_RMTYPEpublic static final java.lang.String COMMAND_RMTYPE The 'Rmtype' command- See Also:
- Constant Field Values
 
 - 
COMMAND_LSCOpublic static final java.lang.String COMMAND_LSCO The 'LsCheckout' command- See Also:
- Constant Field Values
 
 - 
COMMAND_MKELEMpublic static final java.lang.String COMMAND_MKELEM The 'Mkelem' command- See Also:
- Constant Field Values
 
 - 
COMMAND_MKATTRpublic static final java.lang.String COMMAND_MKATTR The 'Mkattr' command- See Also:
- Constant Field Values
 
 - 
COMMAND_MKDIRpublic static final java.lang.String COMMAND_MKDIR The 'Mkdir' command- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
setClearToolDirpublic final void setClearToolDir(java.lang.String dir) Set the directory where the cleartool executable is located.- Parameters:
- dir- the directory containing the cleartool executable
 
 - 
getClearToolCommandprotected final java.lang.String getClearToolCommand() Builds and returns the command string to execute cleartool- Returns:
- String containing path to the executable
 
 - 
setViewPathpublic final void setViewPath(java.lang.String viewPath) Set the path to the item in a ClearCase view to operate on.- Parameters:
- viewPath- Path to the view directory or file
 
 - 
getViewPathpublic java.lang.String getViewPath() Get the path to the item in a clearcase view- Returns:
- mviewPath
 
 - 
getViewPathBasenamepublic java.lang.String getViewPathBasename() Get the basename path of the item in a clearcase view- Returns:
- basename
 
 - 
setObjSelectpublic final void setObjSelect(java.lang.String objSelect) Set the object to operate on.- Parameters:
- objSelect- object to operate on
 
 - 
getObjSelectpublic java.lang.String getObjSelect() Get the object to operate on- Returns:
- mobjSelect
 
 - 
runprotected int run(Commandline cmd) Execute the given command are return success or failure- Parameters:
- cmd- command line to execute
- Returns:
- the exit status of the subprocess or INVALID
 
 - 
runS@Deprecated protected java.lang.String runS(Commandline cmdline) Deprecated.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
 
 - 
runSprotected java.lang.String runS(Commandline cmdline, boolean failOnError) Execute 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
 
 
- 
 
-