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

All Implemented Interfaces:
    Cloneable

Task to perform mklbtype command to ClearCase.

The following attributes are interpreted:

Attribute	Values	Required
typename	Name of the label type to create	Yes
vob	Name of the VOB	No
replace	Replace an existing label definition of the same type	No
global	Either global or ordinary can be specified, not both. Creates a label type that is global to the VOB or to VOBs that use this VOB	No
ordinary	Either global or ordinary can be specified, not both. Creates a label type that can be used only in the current VOB. Default	No
pbranch	Allows the label type to be used once per branch in a given element's version tree	No
shared	Sets the way mastership is checked by ClearCase. See ClearCase documentation for details	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
failonerr	Throw an exception if the command fails. Default is true	No

Field Summary
public static final  String	FLAG_REPLACE	-replace flag -- replace existing label definition of the same type
public static final  String	FLAG_GLOBAL	-global flag -- creates a label type that is global to the VOB or to VOBs that use this VOB
public static final  String	FLAG_ORDINARY	-ordinary flag -- creates a label type that can be used only in the current VOB
public static final  String	FLAG_PBRANCH	-pbranch flag -- allows label type to be used once per branch
public static final  String	FLAG_SHARED	-shared flag -- sets the way mastership is checked by ClearCase
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.CCMklbtype Summary:
execute,   getComment,   getCommentFile,   getGlobal,   getOrdinary,   getPbranch,   getReplace,   getShared,   getTypeName,   getVOB,   setComment,   setCommentFile,   setGlobal,   setOrdinary,   setPbranch,   setReplace,   setShared,   setTypeName,   setVOB

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.CCMklbtype Detail:
public void execute() throws BuildException { Commandline commandLine = new Commandline(); int result = 0; // Check for required attributes if (getTypeName() == null) { throw new BuildException("Required attribute TypeName not specified"); } // build the command line from what we got. the format is // cleartool mklbtype [options...] type-selector... // as specified in the CLEARTOOL help commandLine.setExecutable(getClearToolCommand()); commandLine.createArgument().setValue(COMMAND_MKLBTYPE); checkOptions(commandLine); if (!getFailOnErr()) { getProject().log("Ignoring any errors that occur for: " + getTypeSpecifier(), 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 getComment() { return mComment; } Get comment string
public String getCommentFile() { return mCfile; } Get comment file
public boolean getGlobal() { return mGlobal; } Get global flag status
public boolean getOrdinary() { return mOrdinary; } Get ordinary flag status
public boolean getPbranch() { return mPbranch; } Get pbranch flag status
public boolean getReplace() { return mReplace; } Get replace flag status
public boolean getShared() { return mShared; } Get shared flag status
public String getTypeName() { return mTypeName; } Get type-name string
public String getVOB() { return mVOB; } Get VOB name
public void setComment(String comment) { mComment = comment; } Set comment string
public void setCommentFile(String cfile) { mCfile = cfile; } Set comment file
public void setGlobal(boolean glob) { mGlobal = glob; } Set the global flag
public void setOrdinary(boolean ordinary) { mOrdinary = ordinary; } Set the ordinary flag
public void setPbranch(boolean pbranch) { mPbranch = pbranch; } Set the pbranch flag
public void setReplace(boolean repl) { mReplace = repl; } Set the replace flag
public void setShared(boolean shared) { mShared = shared; } Set the shared flag
public void setTypeName(String tn) { mTypeName = tn; } Set type-name string
public void setVOB(String vob) { mVOB = vob; } Set the VOB name