Apache Ant Core 1.10.14 · org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype

Task attributes
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

Modifier and Type	Field and Description
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_FORCE -force flag -- suppresses confirmation prompts
public static final String	FLAG_IGNORE -ignore flag -- ignore pre-trigger operations when removing a trigger type
public static final String	FLAG_NOCOMMENT -nc flag -- no comment is specified
public static final String	FLAG_RMALL -rmall flag -- removes all instances of a type and the type object itself
private String	mCfile
private String	mComment
private boolean	mIgnore
private boolean	mRmall
private String	mTypeKind
private String	mTypeName
private String	mVOB

Inherited from 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

Constructor Summary

Access	Constructor and Description
public	CCRmtype()

Method Summary

Modifier and Type	Method and Description
private void	checkOptions(Commandline cmd) Check the command line options.
public void	execute() Overrides org.apache.tools.ant.Task.execute. Executes the task.
public String	Returns: String containing the comment getComment() Get comment string
private void	getCommentCommand(Commandline containing the command line string with or without the comment flag and string appended cmd) Get the 'comment' command
public String	Returns: String containing the path to the comment file getCommentFile() Get comment file
private void	getCommentFileCommand(Commandline containing the command line string with or without the commentfile flag and file appended cmd) Get the 'commentfile' command
public boolean	Returns: boolean containing status of ignore flag getIgnore() Get ignore flag status
public boolean	Returns: boolean containing status of rmall flag getRmAll() Get rmall flag status
public String	Returns: String containing the type-kind getTypeKind() Get type-kind string
public String	Returns: String containing the type-name getTypeName() Get type-name string
private String	Returns: the 'type-kind:type-name@vob' specifier getTypeSpecifier() Get the 'type-specifier' string
public String	Returns: String containing VOB name getVOB() Get VOB name
public void	setComment(String the comment string comment) Set comment string
public void	setCommentFile(String the path to the comment file cfile) Set comment file
public void	setIgnore(boolean the status to set the flag to ignore) Set the ignore flag
public void	setRmAll(boolean the status to set the flag to rmall) Set rmall flag
public void	setTypeKind(String the type-kind string tk) Set type-kind string
public void	setTypeName(String the type-name string tn) Set type-name string
public void	setVOB(String the VOB name vob) Set the VOB name

Inherited from org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase:: getClearToolCommand getFailOnErr getObjSelect getViewPath getViewPathBasename run runS runS setClearToolDir setFailOnErr setObjSelect setViewPath

Field Detail

FLAG_COMMENT	back to summary
public static final String FLAG_COMMENT -c flag -- comment to attach to the file

FLAG_COMMENTFILE	back to summary
public static final String FLAG_COMMENTFILE -cfile flag -- file containing a comment to attach to the file

FLAG_FORCE	back to summary
public static final String FLAG_FORCE -force flag -- suppresses confirmation prompts

FLAG_IGNORE	back to summary
public static final String FLAG_IGNORE -ignore flag -- ignore pre-trigger operations when removing a trigger type

FLAG_NOCOMMENT	back to summary
public static final String FLAG_NOCOMMENT -nc flag -- no comment is specified

FLAG_RMALL	back to summary
public static final String FLAG_RMALL -rmall flag -- removes all instances of a type and the type object itself

mCfile	back to summary
private String mCfile

mComment	back to summary
private String mComment

mIgnore	back to summary
private boolean mIgnore

mRmall	back to summary
private boolean mRmall

mTypeKind	back to summary
private String mTypeKind

mTypeName	back to summary
private String mTypeName

mVOB	back to summary
private String mVOB

Constructor Detail

CCRmtype	back to summary
public CCRmtype()

Method Detail

checkOptions	back to summary
private void checkOptions(Commandline cmd) Check the command line options.

execute	back to summary
public void execute() throws BuildException Overrides org.apache.tools.ant.Task.execute. Executes the task. Builds a command line to execute cleartool and then calls Exec's run method to execute the command line. Annotations @Override Exceptions BuildException: if the command fails and failonerr is set to true

execute

back to summary

public void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

Executes the task.

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

Annotations

@Override

Exceptions

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

getComment	back to summary
public String getComment() Get comment string Returns:String String containing the comment

getComment

back to summary

public String getComment()

Get comment string

Returns:String: String containing the comment

getCommentCommand	back to summary
private void getCommentCommand(Commandline cmd) Get the 'comment' command Parameters cmd:Commandline containing the command line string with or without the comment flag and string appended

getCommentCommand

back to summary

private void getCommentCommand(Commandline cmd)

Get the 'comment' command

Parameters

cmd:Commandline: containing the command line string with or without the comment flag and string appended

getCommentFile	back to summary
public String getCommentFile() Get comment file Returns:String String containing the path to the comment file

getCommentFile

back to summary

public String getCommentFile()

Get comment file

Returns:String: String containing the path to the comment file

getCommentFileCommand	back to summary
private void getCommentFileCommand(Commandline cmd) Get the 'commentfile' command Parameters cmd:Commandline containing the command line string with or without the commentfile flag and file appended

getCommentFileCommand

back to summary

private void getCommentFileCommand(Commandline cmd)

Get the 'commentfile' command

Parameters

cmd:Commandline: containing the command line string with or without the commentfile flag and file appended

getIgnore	back to summary
public boolean getIgnore() Get ignore flag status Returns:boolean boolean containing status of ignore flag

getIgnore

back to summary

public boolean getIgnore()

Get ignore flag status

Returns:boolean: boolean containing status of ignore flag

getRmAll	back to summary
public boolean getRmAll() Get rmall flag status Returns:boolean boolean containing status of rmall flag

getRmAll

back to summary

public boolean getRmAll()

Get rmall flag status

Returns:boolean: boolean containing status of rmall flag

getTypeKind	back to summary
public String getTypeKind() Get type-kind string Returns:String String containing the type-kind

getTypeKind

back to summary

public String getTypeKind()

Get type-kind string

Returns:String: String containing the type-kind

getTypeName	back to summary
public String getTypeName() Get type-name string Returns:String String containing the type-name

getTypeName

back to summary

public String getTypeName()

Get type-name string

Returns:String: String containing the type-name

getTypeSpecifier	back to summary
private String getTypeSpecifier() Get the 'type-specifier' string Returns:String the 'type-kind:type-name@vob' specifier

getTypeSpecifier

back to summary

private String getTypeSpecifier()

Get the 'type-specifier' string

Returns:String: the 'type-kind:type-name@vob' specifier

getVOB	back to summary
public String getVOB() Get VOB name Returns:String String containing VOB name

getVOB

back to summary

public String getVOB()

Get VOB name

Returns:String: String containing VOB name

setComment	back to summary
public void setComment(String comment) Set comment string Parameters comment:String the comment string

setComment

back to summary

public void setComment(String comment)

Set comment string

Parameters

comment:String: the comment string

setCommentFile	back to summary
public void setCommentFile(String cfile) Set comment file Parameters cfile:String the path to the comment file

setCommentFile

back to summary

public void setCommentFile(String cfile)

Set comment file

Parameters

cfile:String: the path to the comment file

setIgnore	back to summary
public void setIgnore(boolean ignore) Set the ignore flag Parameters ignore:boolean the status to set the flag to

setIgnore

back to summary

public void setIgnore(boolean ignore)

Set the ignore flag

Parameters

ignore:boolean: the status to set the flag to

setRmAll	back to summary
public void setRmAll(boolean rmall) Set rmall flag Parameters rmall:boolean the status to set the flag to

setRmAll

back to summary

public void setRmAll(boolean rmall)

Set rmall flag

Parameters

rmall:boolean: the status to set the flag to

setTypeKind	back to summary
public void setTypeKind(String tk) Set type-kind string Parameters tk:String the type-kind string

setTypeKind

back to summary

public void setTypeKind(String tk)

Set type-kind string

Parameters

tk:String: the type-kind string

setTypeName	back to summary
public void setTypeName(String tn) Set type-name string Parameters tn:String the type-name string

setTypeName

back to summary

public void setTypeName(String tn)

Set type-name string

Parameters

tn:String: the type-name string

setVOB	back to summary
public void setVOB(String vob) Set the VOB name Parameters vob:String the VOB name

setVOB

back to summary

public void setVOB(String vob)

Set the VOB name

Parameters

vob:String: the VOB name

public Class CCRmtype

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail