org.apache.tools.ant.taskdefs.optional.clearcase

Class ClearCase

public abstract class ClearCase extends Task

A base class for creating tasks for executing commands on ClearCase.

The class extends the 'exec' task as it operates by executing the cleartool program supplied with 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
static StringCOMMAND_CHECKIN
The 'Checkin' command
static StringCOMMAND_CHECKOUT
The 'Checkout' command
static StringCOMMAND_LOCK
The 'Lock' command
static StringCOMMAND_LSCO
The 'LsCheckout' command
static StringCOMMAND_MKATTR
The 'Mkattr' command
static StringCOMMAND_MKBL
The 'Mkbl' command
static StringCOMMAND_MKDIR
The 'Mkdir' command
static StringCOMMAND_MKELEM
The 'Mkelem' command
static StringCOMMAND_MKLABEL
The 'Mklabel' command
static StringCOMMAND_MKLBTYPE
The 'Mklbtype' command
static StringCOMMAND_RMTYPE
The 'Rmtype' command
static StringCOMMAND_UNCHECKOUT
The 'UndoCheckout' command
static StringCOMMAND_UNLOCK
The 'Unlock' command
static StringCOMMAND_UPDATE
The 'Update' command
Method Summary
protected StringgetClearToolCommand()
Builds and returns the command string to execute cleartool
booleangetFailOnErr()
Get failonerr flag status
StringgetObjSelect()
Get the object to operate on
StringgetViewPath()
Get the path to the item in a clearcase view
StringgetViewPathBasename()
Get the basename path of the item in a clearcase view
protected intrun(Commandline cmd)
Execute the given command are return success or failure
protected StringrunS(Commandline cmdline)
Execute the given command, and return it's output
voidsetClearToolDir(String dir)
Set the directory where the cleartool executable is located.
voidsetFailOnErr(boolean failonerr)
If true, command will throw an exception on failure.
voidsetObjSelect(String objSelect)
Set the object to operate on.
voidsetViewPath(String viewPath)
Set the path to the item in a ClearCase view to operate on.

Field Detail

COMMAND_CHECKIN

public static final String COMMAND_CHECKIN
The 'Checkin' command

COMMAND_CHECKOUT

public static final String COMMAND_CHECKOUT
The 'Checkout' command

COMMAND_LOCK

public static final String COMMAND_LOCK
The 'Lock' command

COMMAND_LSCO

public static final String COMMAND_LSCO
The 'LsCheckout' command

COMMAND_MKATTR

public static final String COMMAND_MKATTR
The 'Mkattr' command

COMMAND_MKBL

public static final String COMMAND_MKBL
The 'Mkbl' command

COMMAND_MKDIR

public static final String COMMAND_MKDIR
The 'Mkdir' command

COMMAND_MKELEM

public static final String COMMAND_MKELEM
The 'Mkelem' command

COMMAND_MKLABEL

public static final String COMMAND_MKLABEL
The 'Mklabel' command

COMMAND_MKLBTYPE

public static final String COMMAND_MKLBTYPE
The 'Mklbtype' command

COMMAND_RMTYPE

public static final String COMMAND_RMTYPE
The 'Rmtype' command

COMMAND_UNCHECKOUT

public static final String COMMAND_UNCHECKOUT
The 'UndoCheckout' command

COMMAND_UNLOCK

public static final String COMMAND_UNLOCK
The 'Unlock' command

COMMAND_UPDATE

public static final String COMMAND_UPDATE
The 'Update' command

Method Detail

getClearToolCommand

protected final String getClearToolCommand()
Builds and returns the command string to execute cleartool

Returns: String containing path to the executable

getFailOnErr

public boolean getFailOnErr()
Get failonerr flag status

Returns: boolean containing status of failonerr flag

Since: ant 1.6.1

getObjSelect

public String getObjSelect()
Get the object to operate on

Returns: mobjSelect

getViewPath

public String getViewPath()
Get the path to the item in a clearcase view

Returns: mviewPath

getViewPathBasename

public String getViewPathBasename()
Get the basename path of the item in a clearcase view

Returns: basename

run

protected 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

protected String runS(Commandline cmdline)
Execute the given command, and return it's output

Parameters: cmdline command line to execute

Returns: output of the command line

setClearToolDir

public final void setClearToolDir(String dir)
Set the directory where the cleartool executable is located.

Parameters: dir the directory containing the cleartool executable

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

setObjSelect

public final void setObjSelect(String objSelect)
Set the object to operate on.

Parameters: objSelect object to operate on

setViewPath

public final void setViewPath(String viewPath)
Set the path to the item in a ClearCase view to operate on.

Parameters: viewPath Path to the view directory or file