Home » apache-ant-1.7.1-src » org.apache.tools » ant » taskdefs » optional » clearcase » [javadoc | source]

org.apache.tools.ant.taskdefs.optional.clearcase
public class: CCCheckout [javadoc | source]

java.lang.Object
   org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
         org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
            org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout

All Implemented Interfaces:
    Cloneable

Performs ClearCase checkout.

The following attributes are interpreted:

Attribute	Values	Required
viewpath	Path to the ClearCase view file or directory that the command will operate on	No
reserved	Specifies whether to check out the file as reserved or not	Yes
out	Creates a writable file under a different filename	No
nodata	Checks out the file but does not create an editable file containing its data	No
branch	Specify a branch to check out the file to	No
version	Allows checkout of a version other than main latest	No
nowarn	Suppress warning messages	No
comment	Specify a comment. Only one of comment or cfile may be used.	No
commentfile	Specify a file containing a comment. Only one of comment or cfile may be used.	No
notco	Fail if it's already checked out to the current view. Set to false to ignore it.	No
failonerr	Throw an exception if the command fails. Default is true	No

Field Summary
public static final  String	FLAG_RESERVED	-reserved flag -- check out the file as reserved
public static final  String	FLAG_UNRESERVED	-reserved flag -- check out the file as unreserved
public static final  String	FLAG_OUT	-out flag -- create a writable file under a different filename
public static final  String	FLAG_NODATA	-ndata flag -- checks out the file but does not create an editable file containing its data
public static final  String	FLAG_BRANCH	-branch flag -- checks out the file on a specified branch
public static final  String	FLAG_VERSION	-version flag -- allows checkout of a version that is not main latest
public static final  String	FLAG_NOWARN	-nwarn flag -- suppresses warning messages
public static final  String	FLAG_COMMENT	-c flag -- comment to attach to the file
public static final  String	FLAG_COMMENTFILE	-cfile flag -- file containing a comment to attach to the file
public static final  String	FLAG_NOCOMMENT	-nc flag -- no comment is specified

Fields inherited from org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase:
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

Fields inherited from org.apache.tools.ant.Task:
target,  taskName,  taskType,  wrapper

Fields inherited from org.apache.tools.ant.ProjectComponent:
project,  location,  description

Method from org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout Summary:
execute,   getBranch,   getComment,   getCommentFile,   getNoData,   getNoWarn,   getNotco,   getOut,   getReserved,   getVersion,   setBranch,   setComment,   setCommentFile,   setNoData,   setNoWarn,   setNotco,   setOut,   setReserved,   setVersion

Methods from org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase:
getClearToolCommand,   getFailOnErr,   getObjSelect,   getViewPath,   getViewPathBasename,   run,   runS,   setClearToolDir,   setFailOnErr,   setObjSelect,   setViewPath

Methods from org.apache.tools.ant.Task:
bindToOwner,   execute,   getOwningTarget,   getRuntimeConfigurableWrapper,   getTaskName,   getTaskType,   getWrapper,   handleErrorFlush,   handleErrorOutput,   handleFlush,   handleInput,   handleOutput,   init,   isInvalid,   log,   log,   log,   log,   markInvalid,   maybeConfigure,   perform,   reconfigure,   setOwningTarget,   setRuntimeConfigurableWrapper,   setTaskName,   setTaskType

Methods from org.apache.tools.ant.ProjectComponent:
clone,   getDescription,   getLocation,   getProject,   log,   log,   setDescription,   setLocation,   setProject

Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait

Method from org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout Detail:
public void execute() throws BuildException { Commandline commandLine = new Commandline(); Project aProj = getProject(); int result = 0; // Default the viewpath to basedir if it is not specified if (getViewPath() == null) { setViewPath(aProj.getBaseDir().getPath()); } // build the command line from what we got the format is // cleartool checkout [options...] [viewpath ...] // as specified in the CLEARTOOL.EXE help commandLine.setExecutable(getClearToolCommand()); commandLine.createArgument().setValue(COMMAND_CHECKOUT); checkOptions(commandLine); /* * If configured to not care about whether the element is * already checked out to the current view. * Then check to see if it is checked out. */ if (!getNotco() && lsCheckout()) { getProject().log("Already checked out in this view: " + getViewPathBasename(), Project.MSG_VERBOSE); return; } if (!getFailOnErr()) { getProject().log("Ignoring any errors that occur for: " + getViewPathBasename(), Project.MSG_VERBOSE); } result = run(commandLine); if (Execute.isFailure(result) && getFailOnErr()) { String msg = "Failed executing: " + commandLine.toString(); throw new BuildException(msg, getLocation()); } } Executes the task. Builds a command line to execute cleartool and then calls Exec's run method to execute the command line.
public String getBranch() { return mBranch; } Get branch name
public String getComment() { return mComment; } Get comment string
public String getCommentFile() { return mCfile; } Get comment file
public boolean getNoData() { return mNdata; } Get nodata flag status
public boolean getNoWarn() { return mNwarn; } Get nowarn flag status
public boolean getNotco() { return mNotco; } Get notco flag status
public String getOut() { return mOut; } Get out file
public boolean getReserved() { return mReserved; } Get reserved flag status
public boolean getVersion() { return mVersion; } Get version flag status
public void setBranch(String branch) { mBranch = branch; } Specify a branch to check out the file to.
public void setComment(String comment) { mComment = comment; } Sets the comment string.
public void setCommentFile(String cfile) { mCfile = cfile; } Specifies a file containing a comment.
public void setNoData(boolean ndata) { mNdata = ndata; } If true, checks out the file but does not create an editable file containing its data.
public void setNoWarn(boolean nwarn) { mNwarn = nwarn; } If true, warning messages are suppressed.
public void setNotco(boolean notco) { mNotco = notco; } If true, checkout fails if the element is already checked out to the current view.
public void setOut(String outf) { mOut = outf; } Creates a writable file under a different filename.
public void setReserved(boolean reserved) { mReserved = reserved; } If true, checks out the file as reserved.
public void setVersion(boolean version) { mVersion = version; } If true, allows checkout of a version other than main latest.