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

Task attributes
Attribute	Values	Required
viewpath	Path to the ClearCase view file or directory that the command will operate on	Yes
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
nowarn	Suppress warning messages	No
nocheckout	Do not checkout after element creation	No
checkin	Checkin element after creation	No
preservetime	Preserve the modification time (for checkin)	No
master	Assign mastership of the main branch to the current site	No
eltype	Element type to use during element creation	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_CHECKIN -ci flag -- checkin element after creation
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_ELTYPE -eltype flag -- element type to use during creation
public static final String	FLAG_MASTER -master flag -- change mastership of main branch to current site
public static final String	FLAG_NOCHECKOUT -nco flag -- do not checkout element after creation
public static final String	FLAG_NOCOMMENT -nc flag -- no comment is specified
public static final String	FLAG_NOWARN -nwarn flag -- suppresses warning messages
public static final String	FLAG_PRESERVETIME -ptime flag -- preserves the modification time on checkin
private String	mCfile
private boolean	mCheckin
private String	mComment
private String	mEltype
private boolean	mMaster
private boolean	mNoco
private boolean	mNwarn
private boolean	mPtime

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	CCMkelem()

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 boolean	Returns: boolean containing status of ci flag getCheckin() Get ci flag status
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 String	Returns: String containing the element type getEltype() Get element type
private void	getEltypeCommand(Commandline containing the command line string with or without the comment flag and string appended cmd) Get the 'element type' command
public boolean	Returns: boolean containing status of master flag getMaster() Get master flag status
public boolean	Returns: boolean containing status of noco flag getNoCheckout() Get no checkout flag status
public boolean	Returns: boolean containing status of nwarn flag getNoWarn() Get nowarn flag status
public boolean	Returns: boolean containing status of preservetime flag getPreserveTime() Get preservetime flag status
public void	setCheckin(boolean the status to set the flag to ci) If true, checkin the element after creation
public void	setComment(String the comment string comment) Sets the comment string.
public void	setCommentFile(String the path to the comment file cfile) Specifies a file containing a comment.
public void	setEltype(String to create element eltype) Specifies the element type to use.
public void	setMaster(boolean the status to set the flag to master) If true, changes mastership of the main branch to the current site
public void	setNoCheckout(boolean the status to set the flag to co) If true, do not checkout element after creation.
public void	setNoWarn(boolean the status to set the flag to nwarn) If true, suppress warning messages.
public void	setPreserveTime(boolean the status to set the flag to ptime) If true, preserve the modification time.

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_CHECKIN	back to summary
public static final String FLAG_CHECKIN -ci flag -- checkin element after creation

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_ELTYPE	back to summary
public static final String FLAG_ELTYPE -eltype flag -- element type to use during creation

FLAG_MASTER	back to summary
public static final String FLAG_MASTER -master flag -- change mastership of main branch to current site

FLAG_NOCHECKOUT	back to summary
public static final String FLAG_NOCHECKOUT -nco flag -- do not checkout element after creation

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

FLAG_NOWARN	back to summary
public static final String FLAG_NOWARN -nwarn flag -- suppresses warning messages

FLAG_PRESERVETIME	back to summary
public static final String FLAG_PRESERVETIME -ptime flag -- preserves the modification time on checkin

mCfile	back to summary
private String mCfile

mCheckin	back to summary
private boolean mCheckin

mComment	back to summary
private String mComment

mEltype	back to summary
private String mEltype

mMaster	back to summary
private boolean mMaster

mNoco	back to summary
private boolean mNoco

mNwarn	back to summary
private boolean mNwarn

mPtime	back to summary
private boolean mPtime

Constructor Detail

CCMkelem	back to summary
public CCMkelem()

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

getCheckin	back to summary
public boolean getCheckin() Get ci flag status Returns:boolean boolean containing status of ci flag

getCheckin

back to summary

public boolean getCheckin()

Get ci flag status

Returns:boolean: boolean containing status of ci flag

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

getEltype	back to summary
public String getEltype() Get element type Returns:String String containing the element type

getEltype

back to summary

public String getEltype()

Get element type

Returns:String: String containing the element type

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

getEltypeCommand

back to summary

private void getEltypeCommand(Commandline cmd)

Get the 'element type' command

Parameters

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

getMaster	back to summary
public boolean getMaster() Get master flag status Returns:boolean boolean containing status of master flag

getMaster

back to summary

public boolean getMaster()

Get master flag status

Returns:boolean: boolean containing status of master flag

getNoCheckout	back to summary
public boolean getNoCheckout() Get no checkout flag status Returns:boolean boolean containing status of noco flag

getNoCheckout

back to summary

public boolean getNoCheckout()

Get no checkout flag status

Returns:boolean: boolean containing status of noco flag

getNoWarn	back to summary
public boolean getNoWarn() Get nowarn flag status Returns:boolean boolean containing status of nwarn flag

getNoWarn

back to summary

public boolean getNoWarn()

Get nowarn flag status

Returns:boolean: boolean containing status of nwarn flag

getPreserveTime	back to summary
public boolean getPreserveTime() Get preservetime flag status Returns:boolean boolean containing status of preservetime flag

getPreserveTime

back to summary

public boolean getPreserveTime()

Get preservetime flag status

Returns:boolean: boolean containing status of preservetime flag

setCheckin	back to summary
public void setCheckin(boolean ci) If true, checkin the element after creation Parameters ci:boolean the status to set the flag to

setCheckin

back to summary

public void setCheckin(boolean ci)

If true, checkin the element after creation

Parameters

ci:boolean: the status to set the flag to

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

setComment

back to summary

public void setComment(String comment)

Sets the comment string.

Parameters

comment:String: the comment string

setCommentFile	back to summary
public void setCommentFile(String cfile) Specifies a file containing a comment. Parameters cfile:String the path to the comment file

setCommentFile

back to summary

public void setCommentFile(String cfile)

Specifies a file containing a comment.

Parameters

cfile:String: the path to the comment file

setEltype	back to summary
public void setEltype(String eltype) Specifies the element type to use. Parameters eltype:String to create element

setEltype

back to summary

public void setEltype(String eltype)

Specifies the element type to use.

Parameters

eltype:String: to create element

setMaster	back to summary
public void setMaster(boolean master) If true, changes mastership of the main branch to the current site Parameters master:boolean the status to set the flag to

setMaster

back to summary

public void setMaster(boolean master)

If true, changes mastership of the main branch to the current site

Parameters

master:boolean: the status to set the flag to

setNoCheckout	back to summary
public void setNoCheckout(boolean co) If true, do not checkout element after creation. Parameters co:boolean the status to set the flag to

setNoCheckout

back to summary

public void setNoCheckout(boolean co)

If true, do not checkout element after creation.

Parameters

co:boolean: the status to set the flag to

setNoWarn	back to summary
public void setNoWarn(boolean nwarn) If true, suppress warning messages. Parameters nwarn:boolean the status to set the flag to

setNoWarn

back to summary

public void setNoWarn(boolean nwarn)

If true, suppress warning messages.

Parameters

nwarn:boolean: the status to set the flag to

setPreserveTime	back to summary
public void setPreserveTime(boolean ptime) If true, preserve the modification time. Parameters ptime:boolean the status to set the flag to

setPreserveTime

back to summary

public void setPreserveTime(boolean ptime)

If true, preserve the modification time.

Parameters

ptime:boolean: the status to set the flag to

public Class CCMkelem

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail