Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

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:

AttributeValuesRequired
typekindThe 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
typenameThe name of the type to removeYes
vobName of the VOBNo
ignoreUsed with trigger types only. Forces removal of trigger type even if a pre-operation trigger would prevent its removalNo
rmallRemoves all instances of a type and the type object itselfNo
commentSpecify a comment. Only one of comment or cfile may be used.No
commentfileSpecify a file containing a comment. Only one of comment or cfile may be used.No
failonerrThrow an exception if the command fails. Default is trueNo

Field Summary

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

Fields 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_UPDATE

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Method Summary

void
execute()
Executes the task.
String
getComment()
Get comment string
String
getCommentFile()
Get comment file
boolean
getIgnore()
Get ignore flag status
boolean
getRmAll()
Get rmall flag status
String
getTypeKind()
Get type-kind string
String
getTypeName()
Get type-name string
String
getVOB()
Get VOB name
void
setComment(String comment)
Set comment string
void
setCommentFile(String cfile)
Set comment file
void
setIgnore(boolean ignore)
Set the ignore flag
void
setRmAll(boolean rmall)
Set rmall flag
void
setTypeKind(String tk)
Set type-kind string
void
setTypeName(String tn)
Set type-name string
void
setVOB(String vob)
Set the VOB name

Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase

getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath

Methods inherited from class org.apache.tools.ant.Task

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

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Field Details

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 Details

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.

Overrides:
execute in interface Task
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

Overview Package Tree Index Deprecated About
Copyright B) 2000-2006 Apache Software Foundation. All Rights Reserved.