org.apache.tools.ant.taskdefs.optional.clearcase

Class CCRmtype

public class CCRmtype extends ClearCase

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
static StringFLAG_COMMENT
-c flag -- comment to attach to the file
static StringFLAG_COMMENTFILE
-cfile flag -- file containing a comment to attach to the file
static StringFLAG_FORCE
-force flag -- suppresses confirmation prompts
static StringFLAG_IGNORE
-ignore flag -- ignore pre-trigger operations when removing a trigger type
static StringFLAG_NOCOMMENT
-nc flag -- no comment is specified
static StringFLAG_RMALL
-rmall flag -- removes all instances of a type and the type object itself
Method Summary
voidexecute()
Executes the task.
StringgetComment()
Get comment string
StringgetCommentFile()
Get comment file
booleangetIgnore()
Get ignore flag status
booleangetRmAll()
Get rmall flag status
StringgetTypeKind()
Get type-kind string
StringgetTypeName()
Get type-name string
StringgetVOB()
Get VOB name
voidsetComment(String comment)
Set comment string
voidsetCommentFile(String cfile)
Set comment file
voidsetIgnore(boolean ignore)
Set the ignore flag
voidsetRmAll(boolean rmall)
Set rmall flag
voidsetTypeKind(String tk)
Set type-kind string
voidsetTypeName(String tn)
Set type-name string
voidsetVOB(String vob)
Set the VOB name

Field Detail

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

Method Detail

execute

public void execute()
Executes the task.

Builds a command line to execute cleartool and then calls Exec's run method to execute the command line.

Throws: BuildException if the command fails and failonerr is set to true

getComment

public String getComment()
Get comment string

Returns: String containing the comment

getCommentFile

public String getCommentFile()
Get comment file

Returns: String containing the path to the comment file

getIgnore

public boolean getIgnore()
Get ignore flag status

Returns: boolean containing status of ignore flag

getRmAll

public boolean getRmAll()
Get rmall flag status

Returns: boolean containing status of rmall flag

getTypeKind

public String getTypeKind()
Get type-kind string

Returns: String containing the type-kind

getTypeName

public String getTypeName()
Get type-name string

Returns: String containing the type-name

getVOB

public String getVOB()
Get VOB name

Returns: String containing VOB name

setComment

public void setComment(String comment)
Set comment string

Parameters: comment the comment string

setCommentFile

public void setCommentFile(String cfile)
Set comment file

Parameters: cfile the path to the comment file

setIgnore

public void setIgnore(boolean ignore)
Set the ignore flag

Parameters: ignore the status to set the flag to

setRmAll

public void setRmAll(boolean rmall)
Set rmall flag

Parameters: rmall the status to set the flag to

setTypeKind

public void setTypeKind(String tk)
Set type-kind string

Parameters: tk the type-kind string

setTypeName

public void setTypeName(String tn)
Set type-name string

Parameters: tn the type-name string

setVOB

public void setVOB(String vob)
Set the VOB name

Parameters: vob the VOB name

Copyright