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: CCMkelem [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.CCMkelem

All Implemented Interfaces:
    Cloneable

Performs ClearCase mkelem.

The following attributes are interpreted:

Attribute	Values	Required
viewpath	Path to the ClearCase view file or directory that the command will operate on	Yes
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
nowarn	Suppress warning messages	No
nocheckout	Do not checkout after element creation	No
checkin	Checkin element after creation	No
preservetime	Preserve the modification time (for checkin)	No
master	Assign mastership of the main branch to the current site	No
eltype	Element type to use during element creation	No
failonerr	Throw an exception if the command fails. Default is true	No

Field Summary
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
public static final  String	FLAG_NOWARN	-nwarn flag -- suppresses warning messages
public static final  String	FLAG_PRESERVETIME	-ptime flag -- preserves the modification time on checkin
public static final  String	FLAG_NOCHECKOUT	-nco flag -- do not checkout element after creation
public static final  String	FLAG_CHECKIN	-ci flag -- checkin element after creation
public static final  String	FLAG_MASTER	-master flag -- change mastership of main branch to current site
public static final  String	FLAG_ELTYPE	-eltype flag -- element type to use during creation

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.CCMkelem Summary:
execute,   getCheckin,   getComment,   getCommentFile,   getEltype,   getMaster,   getNoCheckout,   getNoWarn,   getPreserveTime,   setCheckin,   setComment,   setCommentFile,   setEltype,   setMaster,   setNoCheckout,   setNoWarn,   setPreserveTime

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.CCMkelem 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 mkelem [options...] [viewpath ...] // as specified in the CLEARTOOL.EXE help commandLine.setExecutable(getClearToolCommand()); commandLine.createArgument().setValue(COMMAND_MKELEM); checkOptions(commandLine); 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 boolean getCheckin() { return mCheckin; } Get ci flag status
public String getComment() { return mComment; } Get comment string
public String getCommentFile() { return mCfile; } Get comment file
public String getEltype() { return mEltype; } Get element type
public boolean getMaster() { return mMaster; } Get master flag status
public boolean getNoCheckout() { return mNoco; } Get no checkout flag status
public boolean getNoWarn() { return mNwarn; } Get nowarn flag status
public boolean getPreserveTime() { return mPtime; } Get preservetime flag status
public void setCheckin(boolean ci) { mCheckin = ci; } If true, checkin the element after creation
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 setEltype(String eltype) { mEltype = eltype; } Specifies the element type to use.
public void setMaster(boolean master) { mMaster = master; } If true, changes mastership of the main branch to the current site
public void setNoCheckout(boolean co) { mNoco = co; } If true, do not checkout element after creation.
public void setNoWarn(boolean nwarn) { mNwarn = nwarn; } If true, suppress warning messages.
public void setPreserveTime(boolean ptime) { mPtime = ptime; } If true, preserve the modification time.