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

All Implemented Interfaces:
    Cloneable

Task to perform rmtype command to ClearCase.

The following attributes are interpreted:

Attribute	Values	Required
typekind	The kind of type to create. Valid types are: attype attribute type brtype branch type eltype element type hltype hyperlink type lbtype label type trtype trigger type	Yes
typename	The name of the type to remove	Yes
vob	Name of the VOB	No
ignore	Used with trigger types only. Forces removal of trigger type even if a pre-operation trigger would prevent its removal	No
rmall	Removes all instances of a type and the type object itself	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_IGNORE	-ignore flag -- ignore pre-trigger operations when removing a trigger type
public static final  String	FLAG_RMALL	-rmall flag -- removes all instances of a type and the type object itself
public static final  String	FLAG_FORCE	-force flag -- suppresses confirmation prompts
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.CCRmtype Summary:
execute,   getComment,   getCommentFile,   getIgnore,   getRmAll,   getTypeKind,   getTypeName,   getVOB,   setComment,   setCommentFile,   setIgnore,   setRmAll,   setTypeKind,   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.CCRmtype Detail:
public void execute() throws BuildException { Commandline commandLine = new Commandline(); int result = 0; // Check for required attributes if (getTypeKind() == null) { throw new BuildException("Required attribute TypeKind not specified"); } if (getTypeName() == null) { throw new BuildException("Required attribute TypeName not specified"); } // build the command line from what we got. the format is // cleartool rmtype [options...] type-selector... // as specified in the CLEARTOOL help commandLine.setExecutable(getClearToolCommand()); commandLine.createArgument().setValue(COMMAND_RMTYPE); 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 getIgnore() { return mIgnore; } Get ignore flag status
public boolean getRmAll() { return mRmall; } Get rmall flag status
public String getTypeKind() { return mTypeKind; } Get type-kind string
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 setIgnore(boolean ignore) { mIgnore = ignore; } Set the ignore flag
public void setRmAll(boolean rmall) { mRmall = rmall; } Set rmall flag
public void setTypeKind(String tk) { mTypeKind = tk; } Set type-kind string
public void setTypeName(String tn) { mTypeName = tn; } Set type-name string
public void setVOB(String vob) { mVOB = vob; } Set the VOB name