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 Summary
FieldsModifier 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.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier 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.Task
bindToOwner, 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.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Field Details
-
COMMAND_UPDATE
The 'Update' command- See Also:
-
COMMAND_CHECKOUT
The 'Checkout' command- See Also:
-
COMMAND_CHECKIN
The 'Checkin' command- See Also:
-
COMMAND_UNCHECKOUT
The 'UndoCheckout' command- See Also:
-
COMMAND_LOCK
The 'Lock' command- See Also:
-
COMMAND_UNLOCK
The 'Unlock' command- See Also:
-
COMMAND_MKBL
The 'Mkbl' command- See Also:
-
COMMAND_MKLABEL
The 'Mklabel' command- See Also:
-
COMMAND_MKLBTYPE
The 'Mklbtype' command- See Also:
-
COMMAND_RMTYPE
The 'Rmtype' command- See Also:
-
COMMAND_LSCO
The 'LsCheckout' command- See Also:
-
COMMAND_MKELEM
The 'Mkelem' command- See Also:
-
COMMAND_MKATTR
The 'Mkattr' command- See Also:
-
COMMAND_MKDIR
The 'Mkdir' command- See Also:
-
-
Constructor Details
-
ClearCase
public ClearCase()
-
-
Method Details
-
setClearToolDir
Set the directory where the cleartool executable is located.- Parameters:
dir- the directory containing the cleartool executable
-
getClearToolCommand
Builds and returns the command string to execute cleartool- Returns:
- String containing path to the executable
-
setViewPath
Set the path to the item in a ClearCase view to operate on.- Parameters:
viewPath- Path to the view directory or file
-
getViewPath
Get the path to the item in a clearcase view- Returns:
- mviewPath
-
getViewPathBasename
Get the basename path of the item in a clearcase view- Returns:
- basename
-
setObjSelect
Set the object to operate on.- Parameters:
objSelect- object to operate on
-
getObjSelect
Get the object to operate on- Returns:
- mobjSelect
-
run
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.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
-
runS
Execute the given command, and return it's output- Parameters:
cmdline- command line to executefailOnError- whether to fail the build if the command fails- Returns:
- output of the command line
- Since:
- Ant 1.10.6
-
setFailOnErr
public 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
-
getFailOnErr
public boolean getFailOnErr()Get failonerr flag status- Returns:
- boolean containing status of failonerr flag
- Since:
- ant 1.6.1
-