org.apache.tools.ant.taskdefs.optional.clearcase
Class CCRmtype
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 |
static String | FLAG_COMMENT - -c flag -- comment to attach to the file
|
static String | FLAG_COMMENTFILE - -cfile flag -- file containing a comment to attach to the file
|
static String | FLAG_FORCE - -force flag -- suppresses confirmation prompts
|
static String | FLAG_IGNORE - -ignore flag -- ignore pre-trigger operations when removing a trigger type
|
static String | FLAG_NOCOMMENT - -nc flag -- no comment is specified
|
static String | FLAG_RMALL - -rmall flag -- removes all instances of a type and the type object itself
|
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_UPDATE |
getClearToolCommand , getFailOnErr , getObjSelect , getViewPath , getViewPathBasename , run , runS , setClearToolDir , setFailOnErr , setObjSelect , setViewPath |
execute , getDescription , getLocation , getOwningTarget , getRuntimeConfigurableWrapper , getTaskName , getTaskType , getWrapper , handleErrorFlush , handleErrorOutput , handleFlush , handleInput , handleOutput , init , isInvalid , log , log , maybeConfigure , perform , reconfigure , setDescription , setLocation , setOwningTarget , setRuntimeConfigurableWrapper , setTaskName , setTaskType |
FLAG_COMMENT
public static final String FLAG_COMMENT
-c flag -- comment to attach to the file
FLAG_COMMENTFILE
public static final String FLAG_COMMENTFILE
-cfile flag -- file containing a comment to attach to the file
FLAG_FORCE
public static final String FLAG_FORCE
-force flag -- suppresses confirmation prompts
FLAG_IGNORE
public static final String FLAG_IGNORE
-ignore flag -- ignore pre-trigger operations when removing a trigger type
FLAG_NOCOMMENT
public static final String FLAG_NOCOMMENT
-nc flag -- no comment is specified
FLAG_RMALL
public static final String FLAG_RMALL
-rmall flag -- removes all instances of a type and the type object itself
execute
public void execute()
throws BuildException
Executes the task.
Builds a command line to execute cleartool and then calls Exec's run method
to execute the command line.
- execute in interface Task
BuildException
- if the command fails and failonerr is set to true
getComment
public String getComment()
Get comment string
- String containing the comment
getCommentFile
public String getCommentFile()
Get comment file
- String containing the path to the comment file
getIgnore
public boolean getIgnore()
Get ignore flag status
- boolean containing status of ignore flag
getRmAll
public boolean getRmAll()
Get rmall flag status
- boolean containing status of rmall flag
getTypeKind
public String getTypeKind()
Get type-kind string
- String containing the type-kind
getTypeName
public String getTypeName()
Get type-name string
- String containing the type-name
getVOB
public String getVOB()
Get VOB name
- String containing VOB name
setComment
public void setComment(String comment)
Set comment string
comment
- the comment string
setCommentFile
public void setCommentFile(String cfile)
Set comment file
cfile
- the path to the comment file
setIgnore
public void setIgnore(boolean ignore)
Set the ignore flag
ignore
- the status to set the flag to
setRmAll
public void setRmAll(boolean rmall)
Set rmall flag
rmall
- the status to set the flag to
setTypeKind
public void setTypeKind(String tk)
Set type-kind string
tk
- the type-kind string
setTypeName
public void setTypeName(String tn)
Set type-name string
tn
- the type-name string
setVOB
public void setVOB(String vob)
Set the VOB name
vob
- the VOB name
Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.