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

Task attributes
Attribute	Values	Required
typename	Name of the label type to create	Yes
vob	Name of the VOB	No
replace	Replace an existing label definition of the same type	No
global	Either global or ordinary can be specified, not both. Creates a label type that is global to the VOB or to VOBs that use this VOB	No
ordinary	Either global or ordinary can be specified, not both. Creates a label type that can be used only in the current VOB. Default	No
pbranch	Allows the label type to be used once per branch in a given element's version tree	No
shared	Sets the way mastership is checked by ClearCase. See ClearCase documentation for details	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_GLOBAL -global flag -- creates a label type that is global to the VOB or to VOBs that use this VOB
public static final String	FLAG_NOCOMMENT -nc flag -- no comment is specified
public static final String	FLAG_ORDINARY -ordinary flag -- creates a label type that can be used only in the current VOB
public static final String	FLAG_PBRANCH -pbranch flag -- allows label type to be used once per branch
public static final String	FLAG_REPLACE -replace flag -- replace existing label definition of the same type
public static final String	FLAG_SHARED -shared flag -- sets the way mastership is checked by ClearCase
private String	mCfile
private String	mComment
private boolean	mGlobal
private boolean	mOrdinary
private boolean	mPbranch
private boolean	mReplace
private boolean	mShared
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	CCMklbtype()

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 global flag getGlobal() Get global flag status
public boolean	Returns: boolean containing status of ordinary flag getOrdinary() Get ordinary flag status
public boolean	Returns: boolean containing status of pbranch flag getPbranch() Get pbranch flag status
public boolean	Returns: boolean containing status of replace flag getReplace() Get replace flag status
public boolean	Returns: boolean containing status of shared flag getShared() Get shared flag status
public String	Returns: String containing the type-name getTypeName() Get type-name string
private String	Returns: the 'type-name-specifier' command if the attribute was specified, otherwise an empty string getTypeSpecifier() Get the type-name specifier
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	setGlobal(boolean the status to set the flag to glob) Set the global flag
public void	setOrdinary(boolean the status to set the flag to ordinary) Set the ordinary flag
public void	setPbranch(boolean the status to set the flag to pbranch) Set the pbranch flag
public void	setReplace(boolean the status to set the flag to repl) Set the replace flag
public void	setShared(boolean the status to set the flag to shared) Set the shared flag
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_GLOBAL	back to summary
public static final String FLAG_GLOBAL -global flag -- creates a label type that is global to the VOB or to VOBs that use this VOB

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

FLAG_ORDINARY	back to summary
public static final String FLAG_ORDINARY -ordinary flag -- creates a label type that can be used only in the current VOB

FLAG_PBRANCH	back to summary
public static final String FLAG_PBRANCH -pbranch flag -- allows label type to be used once per branch

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

FLAG_SHARED	back to summary
public static final String FLAG_SHARED -shared flag -- sets the way mastership is checked by ClearCase

mCfile	back to summary
private String mCfile

mComment	back to summary
private String mComment

mGlobal	back to summary
private boolean mGlobal

mOrdinary	back to summary
private boolean mOrdinary

mPbranch	back to summary
private boolean mPbranch

mReplace	back to summary
private boolean mReplace

mShared	back to summary
private boolean mShared

mTypeName	back to summary
private String mTypeName

mVOB	back to summary
private String mVOB

Constructor Detail

CCMklbtype	back to summary
public CCMklbtype()

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

getGlobal	back to summary
public boolean getGlobal() Get global flag status Returns:boolean boolean containing status of global flag

getGlobal

back to summary

public boolean getGlobal()

Get global flag status

Returns:boolean: boolean containing status of global flag

getOrdinary	back to summary
public boolean getOrdinary() Get ordinary flag status Returns:boolean boolean containing status of ordinary flag

getOrdinary

back to summary

public boolean getOrdinary()

Get ordinary flag status

Returns:boolean: boolean containing status of ordinary flag

getPbranch	back to summary
public boolean getPbranch() Get pbranch flag status Returns:boolean boolean containing status of pbranch flag

getPbranch

back to summary

public boolean getPbranch()

Get pbranch flag status

Returns:boolean: boolean containing status of pbranch 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

getShared	back to summary
public boolean getShared() Get shared flag status Returns:boolean boolean containing status of shared flag

getShared

back to summary

public boolean getShared()

Get shared flag status

Returns:boolean: boolean containing status of shared flag

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-name specifier Returns:String the 'type-name-specifier' command if the attribute was specified, otherwise an empty string

getTypeSpecifier

back to summary

private String getTypeSpecifier()

Get the type-name specifier

Returns:String: the 'type-name-specifier' command if the attribute was specified, otherwise an empty string

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

setGlobal	back to summary
public void setGlobal(boolean glob) Set the global flag Parameters glob:boolean the status to set the flag to

setGlobal

back to summary

public void setGlobal(boolean glob)

Set the global flag

Parameters

glob:boolean: the status to set the flag to

setOrdinary	back to summary
public void setOrdinary(boolean ordinary) Set the ordinary flag Parameters ordinary:boolean the status to set the flag to

setOrdinary

back to summary

public void setOrdinary(boolean ordinary)

Set the ordinary flag

Parameters

ordinary:boolean: the status to set the flag to

setPbranch	back to summary
public void setPbranch(boolean pbranch) Set the pbranch flag Parameters pbranch:boolean the status to set the flag to

setPbranch

back to summary

public void setPbranch(boolean pbranch)

Set the pbranch flag

Parameters

pbranch:boolean: the status to set the flag to

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

setReplace

back to summary

public void setReplace(boolean repl)

Set the replace flag

Parameters

repl:boolean: the status to set the flag to

setShared	back to summary
public void setShared(boolean shared) Set the shared flag Parameters shared:boolean the status to set the flag to

setShared

back to summary

public void setShared(boolean shared)

Set the shared flag

Parameters

shared:boolean: the status to set the flag to

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 CCMklbtype

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail