Class CCRmtype
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
FieldsModifier and TypeFieldDescriptionstatic final String-c flag -- comment to attach to the filestatic final String-cfile flag -- file containing a comment to attach to the filestatic final String-force flag -- suppresses confirmation promptsstatic final String-ignore flag -- ignore pre-trigger operations when removing a trigger typestatic final String-nc flag -- no comment is specifiedstatic final String-rmall flag -- removes all instances of a type and the type object itselfFields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_LOCK, COMMAND_LSCO, COMMAND_MKATTR, COMMAND_MKBL, COMMAND_MKDIR, COMMAND_MKELEM, COMMAND_MKLABEL, COMMAND_MKLBTYPE, COMMAND_RMTYPE, COMMAND_UNCHECKOUT, COMMAND_UNLOCK, COMMAND_UPDATEFields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidexecute()Executes the task.Get comment stringGet comment filebooleanGet ignore flag statusbooleangetRmAll()Get rmall flag statusGet type-kind stringGet type-name stringgetVOB()Get VOB namevoidsetComment(String comment) Set comment stringvoidsetCommentFile(String cfile) Set comment filevoidsetIgnore(boolean ignore) Set the ignore flagvoidsetRmAll(boolean rmall) Set rmall flagvoidsetTypeKind(String tk) Set type-kind stringvoidsetTypeName(String tn) Set type-name stringvoidSet the VOB nameMethods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPathMethods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Field Details
-
FLAG_IGNORE
-ignore flag -- ignore pre-trigger operations when removing a trigger type- See Also:
-
FLAG_RMALL
-rmall flag -- removes all instances of a type and the type object itself- See Also:
-
FLAG_FORCE
-force flag -- suppresses confirmation prompts- See Also:
-
FLAG_COMMENT
-c flag -- comment to attach to the file- See Also:
-
FLAG_COMMENTFILE
-cfile flag -- file containing a comment to attach to the file- See Also:
-
FLAG_NOCOMMENT
-nc flag -- no comment is specified- See Also:
-
-
Constructor Details
-
CCRmtype
public CCRmtype()
-
-
Method Details
-
execute
Executes the task.Builds a command line to execute cleartool and then calls Exec's run method to execute the command line.
- Overrides:
executein classTask- Throws:
BuildException- if the command fails and failonerr is set to true
-
setIgnore
public void setIgnore(boolean ignore) Set the ignore flag- Parameters:
ignore- the status to set the flag to
-
getIgnore
public boolean getIgnore()Get ignore flag status- Returns:
- boolean containing status of ignore flag
-
setRmAll
public void setRmAll(boolean rmall) Set rmall flag- Parameters:
rmall- the status to set the flag to
-
getRmAll
public boolean getRmAll()Get rmall flag status- Returns:
- boolean containing status of rmall flag
-
setComment
Set comment string- Parameters:
comment- the comment string
-
getComment
Get comment string- Returns:
- String containing the comment
-
setCommentFile
Set comment file- Parameters:
cfile- the path to the comment file
-
getCommentFile
Get comment file- Returns:
- String containing the path to the comment file
-
setTypeKind
Set type-kind string- Parameters:
tk- the type-kind string
-
getTypeKind
Get type-kind string- Returns:
- String containing the type-kind
-
setTypeName
Set type-name string- Parameters:
tn- the type-name string
-
getTypeName
Get type-name string- Returns:
- String containing the type-name
-
setVOB
Set the VOB name- Parameters:
vob- the VOB name
-
getVOB
Get VOB name- Returns:
- String containing VOB name
-