org.apache.tools.ant.taskdefs.optional.clearcase

Class CCMkelem

public class CCMkelem extends ClearCase

Performs ClearCase mkelem.

The following attributes are interpreted:

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
static StringFLAG_CHECKIN
-ci flag -- checkin element after creation
static StringFLAG_COMMENT
-c flag -- comment to attach to the file
static StringFLAG_COMMENTFILE
-cfile flag -- file containing a comment to attach to the file
static StringFLAG_ELTYPE
-eltype flag -- element type to use during creation
static StringFLAG_MASTER
-master flag -- change mastership of main branch to current site
static StringFLAG_NOCHECKOUT
-nco flag -- do not checkout element after creation
static StringFLAG_NOCOMMENT
-nc flag -- no comment is specified
static StringFLAG_NOWARN
-nwarn flag -- suppresses warning messages
static StringFLAG_PRESERVETIME
-ptime flag -- preserves the modification time on checkin
Method Summary
voidexecute()
Executes the task.
booleangetCheckin()
Get ci flag status
StringgetComment()
Get comment string
StringgetCommentFile()
Get comment file
StringgetEltype()
Get element type
booleangetMaster()
Get master flag status
booleangetNoCheckout()
Get no checkout flag status
booleangetNoWarn()
Get nowarn flag status
booleangetPreserveTime()
Get preservetime flag status
voidsetCheckin(boolean ci)
If true, checkin the element after creation
voidsetComment(String comment)
Sets the comment string.
voidsetCommentFile(String cfile)
Specifies a file containing a comment.
voidsetEltype(String eltype)
Specifies the element type to use.
voidsetMaster(boolean master)
If true, changes mastership of the main branch to the current site
voidsetNoCheckout(boolean co)
If true, do not checkout element after creation.
voidsetNoWarn(boolean nwarn)
If true, suppress warning messages.
voidsetPreserveTime(boolean ptime)
If true, preserve the modification time.

Field Detail

FLAG_CHECKIN

public static final String FLAG_CHECKIN
-ci flag -- checkin element after creation

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_ELTYPE

public static final String FLAG_ELTYPE
-eltype flag -- element type to use during creation

FLAG_MASTER

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

FLAG_NOCHECKOUT

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

FLAG_NOCOMMENT

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

FLAG_NOWARN

public static final String FLAG_NOWARN
-nwarn flag -- suppresses warning messages

FLAG_PRESERVETIME

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

Method Detail

execute

public void execute()
Executes the task.

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

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

getCheckin

public boolean getCheckin()
Get ci flag status

Returns: boolean containing status of ci flag

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

getEltype

public String getEltype()
Get element type

Returns: String containing the element type

getMaster

public boolean getMaster()
Get master flag status

Returns: boolean containing status of master flag

getNoCheckout

public boolean getNoCheckout()
Get no checkout flag status

Returns: boolean containing status of noco flag

getNoWarn

public boolean getNoWarn()
Get nowarn flag status

Returns: boolean containing status of nwarn flag

getPreserveTime

public boolean getPreserveTime()
Get preservetime flag status

Returns: boolean containing status of preservetime flag

setCheckin

public void setCheckin(boolean ci)
If true, checkin the element after creation

Parameters: ci the status to set the flag to

setComment

public void setComment(String comment)
Sets the comment string.

Parameters: comment the comment string

setCommentFile

public void setCommentFile(String cfile)
Specifies a file containing a comment.

Parameters: cfile the path to the comment file

setEltype

public void setEltype(String eltype)
Specifies the element type to use.

Parameters: eltype to create element

setMaster

public void setMaster(boolean master)
If true, changes mastership of the main branch to the current site

Parameters: master the status to set the flag to

setNoCheckout

public void setNoCheckout(boolean co)
If true, do not checkout element after creation.

Parameters: co the status to set the flag to

setNoWarn

public void setNoWarn(boolean nwarn)
If true, suppress warning messages.

Parameters: nwarn the status to set the flag to

setPreserveTime

public void setPreserveTime(boolean ptime)
If true, preserve the modification time.

Parameters: ptime the status to set the flag to

Copyright