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

Task attributes
Attribute	Values	Required
viewpath	Path to the ClearCase view file or directory that the command will operate on	No
replace	Replace a label of the same type on the same branch	No
recurse	Process each subdirectory under viewpath	No
version	Identify a specific version to attach the label to	No
typename	Name of the label type	Yes
vob	Name of the VOB	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_NOCOMMENT -nc flag -- no comment is specified
public static final String	FLAG_RECURSE -recurse flag -- process all subdirectories
public static final String	FLAG_REPLACE -replace flag -- replace another label of the same type
public static final String	FLAG_VERSION -version flag -- attach label to specified version
private String	mCfile
private String	mComment
private boolean	mRecurse
private boolean	mReplace
private String	mTypeName
private String	mVersion
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	CCMklabel()

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 recurse flag getRecurse() Get recurse flag status
public boolean	Returns: boolean containing status of replace flag getReplace() Get replace flag status
private void	getTypeCommand(Commandline containing the command line string with or without the type-name cmd) Get the type-name
public String	Returns: String containing type name getTypeName() Get type-name
public String	Returns: boolean containing status of version flag getVersion() Get version flag status
private void	getVersionCommand(Commandline CommandLine containing the command line string with or without the version flag and string appended cmd) Get the 'version' command
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	setRecurse(boolean the status to set the flag to recurse) Set recurse flag
public void	setReplace(boolean the status to set the flag to replace) Set the replace flag
public void	setTypeName(String the type name tn) Set the type-name
public void	setVersion(String the status to set the flag to version) Set the version flag
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_NOCOMMENT	back to summary
public static final String FLAG_NOCOMMENT -nc flag -- no comment is specified

FLAG_RECURSE	back to summary
public static final String FLAG_RECURSE -recurse flag -- process all subdirectories

FLAG_REPLACE	back to summary
public static final String FLAG_REPLACE -replace flag -- replace another label of the same type

FLAG_VERSION	back to summary
public static final String FLAG_VERSION -version flag -- attach label to specified version

mCfile	back to summary
private String mCfile

mComment	back to summary
private String mComment

mRecurse	back to summary
private boolean mRecurse

mReplace	back to summary
private boolean mReplace

mTypeName	back to summary
private String mTypeName

mVersion	back to summary
private String mVersion

mVOB	back to summary
private String mVOB

Constructor Detail

CCMklabel	back to summary
public CCMklabel()

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

getRecurse	back to summary
public boolean getRecurse() Get recurse flag status Returns:boolean boolean containing status of recurse flag

getRecurse

back to summary

public boolean getRecurse()

Get recurse flag status

Returns:boolean: boolean containing status of recurse flag

getReplace	back to summary
public boolean getReplace() Get replace flag status Returns:boolean boolean containing status of replace flag

getReplace

back to summary

public boolean getReplace()

Get replace flag status

Returns:boolean: boolean containing status of replace flag

getTypeCommand	back to summary
private void getTypeCommand(Commandline cmd) Get the type-name Parameters cmd:Commandline containing the command line string with or without the type-name

getTypeCommand

back to summary

private void getTypeCommand(Commandline cmd)

Get the type-name

Parameters

cmd:Commandline: containing the command line string with or without the type-name

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

getTypeName

back to summary

public String getTypeName()

Get type-name

Returns:String: String containing type name

getVersion	back to summary
public String getVersion() Get version flag status Returns:String boolean containing status of version flag

getVersion

back to summary

public String getVersion()

Get version flag status

Returns:String: boolean containing status of version flag

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

getVersionCommand

back to summary

private void getVersionCommand(Commandline cmd)

Get the 'version' command

Parameters

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

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

setRecurse	back to summary
public void setRecurse(boolean recurse) Set recurse flag Parameters recurse:boolean the status to set the flag to

setRecurse

back to summary

public void setRecurse(boolean recurse)

Set recurse flag

Parameters

recurse:boolean: the status to set the flag to

setReplace	back to summary
public void setReplace(boolean replace) Set the replace flag Parameters replace:boolean the status to set the flag to

setReplace

back to summary

public void setReplace(boolean replace)

Set the replace flag

Parameters

replace:boolean: the status to set the flag to

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

setTypeName

back to summary

public void setTypeName(String tn)

Set the type-name

Parameters

tn:String: the type name

setVersion	back to summary
public void setVersion(String version) Set the version flag Parameters version:String the status to set the flag to

setVersion

back to summary

public void setVersion(String version)

Set the version flag

Parameters

version:String: the status to set the flag to

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 CCMklabel

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail