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

Class CCMkelem


public class CCMkelem
extends ClearCase

Performs ClearCase mkelem.

The following attributes are interpreted:

AttributeValuesRequired
viewpathPath to the ClearCase view file or directory that the command will operate onYes
commentSpecify a comment. Only one of comment or cfile may be used.No
commentfileSpecify a file containing a comment. Only one of comment or cfile may be used.No
nowarnSuppress warning messagesNo
nocheckoutDo not checkout after element creationNo
checkinCheckin element after creationNo
preservetimePreserve the modification time (for checkin)No
masterAssign mastership of the main branch to the current siteNo
eltypeElement type to use during element creationNo
failonerrThrow an exception if the command fails. Default is trueNo

Field Summary

static String
FLAG_CHECKIN
-ci flag -- checkin element after creation
static String
FLAG_COMMENT
-c flag -- comment to attach to the file
static String
FLAG_COMMENTFILE
-cfile flag -- file containing a comment to attach to the file
static String
FLAG_ELTYPE
-eltype flag -- element type to use during creation
static String
FLAG_MASTER
-master flag -- change mastership of main branch to current site
static String
FLAG_NOCHECKOUT
-nco flag -- do not checkout element after creation
static String
FLAG_NOCOMMENT
-nc flag -- no comment is specified
static String
FLAG_NOWARN
-nwarn flag -- suppresses warning messages
static String
FLAG_PRESERVETIME
-ptime flag -- preserves the modification time on checkin

Fields inherited from class 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

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Method Summary

void
execute()
Executes the task.
boolean
getCheckin()
Get ci flag status
String
getComment()
Get comment string
String
getCommentFile()
Get comment file
String
getEltype()
Get element type
boolean
getMaster()
Get master flag status
boolean
getNoCheckout()
Get no checkout flag status
boolean
getNoWarn()
Get nowarn flag status
boolean
getPreserveTime()
Get preservetime flag status
void
setCheckin(boolean ci)
If true, checkin the element after creation
void
setComment(String comment)
Sets the comment string.
void
setCommentFile(String cfile)
Specifies a file containing a comment.
void
setEltype(String eltype)
Specifies the element type to use.
void
setMaster(boolean master)
If true, changes mastership of the main branch to the current site
void
setNoCheckout(boolean co)
If true, do not checkout element after creation.
void
setNoWarn(boolean nwarn)
If true, suppress warning messages.
void
setPreserveTime(boolean ptime)
If true, preserve the modification time.

Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase

getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath

Methods inherited from class org.apache.tools.ant.Task

execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Field Details

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 Details

execute

public void execute()
            throws BuildException
Executes the task.

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

Overrides:
execute in interface Task
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 B) 2000-2006 Apache Software Foundation. All Rights Reserved.