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

java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.Task
              |
              +--org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
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.

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 java.lang.String COMMAND_CHECKIN
          The 'Checkin' command
static java.lang.String COMMAND_CHECKOUT
          The 'Checkout' command
static java.lang.String COMMAND_LOCK
          The 'Lock' command
static java.lang.String COMMAND_LSCO
          The 'LsCheckout' command
static java.lang.String COMMAND_MKATTR
          The 'Mkattr' command
static java.lang.String COMMAND_MKBL
          The 'Mkbl' command
static java.lang.String COMMAND_MKDIR
          The 'Mkdir' command
static java.lang.String COMMAND_MKELEM
          The 'Mkelem' command
static java.lang.String COMMAND_MKLABEL
          The 'Mklabel' command
static java.lang.String COMMAND_MKLBTYPE
          The 'Mklbtype' command
static java.lang.String COMMAND_RMTYPE
          The 'Rmtype' command
static java.lang.String COMMAND_UNCHECKOUT
          The 'UndoCheckout' command
static java.lang.String COMMAND_UNLOCK
          The 'Unlock' command
static java.lang.String COMMAND_UPDATE
          The 'Update' command
 
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
ClearCase()
           
 
Method Summary
protected  java.lang.String getClearToolCommand()
          Builds and returns the command string to execute cleartool
 boolean getFailOnErr()
          Get failonerr flag status
 java.lang.String getObjSelect()
          Get the object to operate on
 java.lang.String getViewPath()
          Get the path to the item in a clearcase view
 java.lang.String getViewPathBasename()
          Get the basename path of the item in a clearcase view
protected  int run(Commandline cmd)
          Execute the given command are return success or failure
protected  java.lang.String runS(Commandline cmdline)
          Execute the given command, and return it's output
 void setClearToolDir(java.lang.String dir)
          Set the directory where the cleartool executable is located.
 void setFailOnErr(boolean failonerr)
          If true, command will throw an exception on failure.
 void setObjSelect(java.lang.String objSelect)
          Set the object to operate on.
 void setViewPath(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.Task
execute, 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

COMMAND_UPDATE

public static final java.lang.String COMMAND_UPDATE
The 'Update' command

See Also:
Constant Field Values

COMMAND_CHECKOUT

public static final java.lang.String COMMAND_CHECKOUT
The 'Checkout' command

See Also:
Constant Field Values

COMMAND_CHECKIN

public static final java.lang.String COMMAND_CHECKIN
The 'Checkin' command

See Also:
Constant Field Values

COMMAND_UNCHECKOUT

public static final java.lang.String COMMAND_UNCHECKOUT
The 'UndoCheckout' command

See Also:
Constant Field Values

COMMAND_LOCK

public static final java.lang.String COMMAND_LOCK
The 'Lock' command

See Also:
Constant Field Values

COMMAND_UNLOCK

public static final java.lang.String COMMAND_UNLOCK
The 'Unlock' command

See Also:
Constant Field Values

COMMAND_MKBL

public static final java.lang.String COMMAND_MKBL
The 'Mkbl' command

See Also:
Constant Field Values

COMMAND_MKLABEL

public static final java.lang.String COMMAND_MKLABEL
The 'Mklabel' command

See Also:
Constant Field Values

COMMAND_MKLBTYPE

public static final java.lang.String COMMAND_MKLBTYPE
The 'Mklbtype' command

See Also:
Constant Field Values

COMMAND_RMTYPE

public static final java.lang.String COMMAND_RMTYPE
The 'Rmtype' command

See Also:
Constant Field Values

COMMAND_LSCO

public static final java.lang.String COMMAND_LSCO
The 'LsCheckout' command

See Also:
Constant Field Values

COMMAND_MKELEM

public static final java.lang.String COMMAND_MKELEM
The 'Mkelem' command

See Also:
Constant Field Values

COMMAND_MKATTR

public static final java.lang.String COMMAND_MKATTR
The 'Mkattr' command

See Also:
Constant Field Values

COMMAND_MKDIR

public static final java.lang.String COMMAND_MKDIR
The 'Mkdir' command

See Also:
Constant Field Values
Constructor Detail

ClearCase

public ClearCase()
Method Detail

setClearToolDir

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

Parameters:
dir - the directory containing the cleartool executable

getClearToolCommand

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

Returns:
String containing path to the executable

setViewPath

public 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

getViewPath

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

Returns:
mviewPath

getViewPathBasename

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

Returns:
basename

setObjSelect

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

Parameters:
objSelect - object to operate on

getObjSelect

public java.lang.String getObjSelect()
Get the object to operate on

Returns:
mobjSelect

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 java.lang.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

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


Copyright 2000-2005 Apache Software Foundation. All Rights Reserved.