Class CCMkelem

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

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

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

All Implemented Interfaces:

Cloneable

public class CCMkelem
extends ClearCase

Performs ClearCase mkelem.

The following attributes are interpreted:

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

Fields

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

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

Modifier and Type	Field	Description
static final String	COMMAND_CHECKIN	The 'Checkin' command
static final String	COMMAND_CHECKOUT	The 'Checkout' command
static final String	COMMAND_LOCK	The 'Lock' command
static final String	COMMAND_LSCO	The 'LsCheckout' command
static final String	COMMAND_MKATTR	The 'Mkattr' command
static final String	COMMAND_MKBL	The 'Mkbl' command
static final String	COMMAND_MKDIR	The 'Mkdir' command
static final String	COMMAND_MKELEM	The 'Mkelem' command
static final String	COMMAND_MKLABEL	The 'Mklabel' command
static final String	COMMAND_MKLBTYPE	The 'Mklbtype' command
static final String	COMMAND_RMTYPE	The 'Rmtype' command
static final String	COMMAND_UNCHECKOUT	The 'UndoCheckout' command
static final String	COMMAND_UNLOCK	The 'Unlock' command
static final String	COMMAND_UPDATE	The 'Update' command

Fields inherited from class Task

target, taskName, taskType, wrapper

Modifier and Type	Field	Description
protected Target	target	Deprecated. since 1.6.x.
protected String	taskName	Deprecated. since 1.6.x.
protected String	taskType	Deprecated. since 1.6.x.
protected RuntimeConfigurable	wrapper	Deprecated. since 1.6.x.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
CCMkelem()

Method Summary

Modifier and Type	Method	Description
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 ClearCase

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

Modifier and Type	Method	Description
protected final String	getClearToolCommand()	Builds and returns the command string to execute cleartool
boolean	getFailOnErr()	Get failonerr flag status
String	getObjSelect()	Get the object to operate on
String	getViewPath()	Get the path to the item in a clearcase view
String	getViewPathBasename()	Get the basename path of the item in a clearcase view
protected int	run(Commandline cmd)	Execute the given command are return success or failure
protected String	runS(Commandline cmdline)	Deprecated. use the two arg version instead
protected String	runS(Commandline cmdline, boolean failOnError)	Execute the given command, and return it's output
final void	setClearToolDir(String dir)	Set the directory where the cleartool executable is located.
void	setFailOnErr(boolean failonerr)	If true, command will throw an exception on failure.
final void	setObjSelect(String objSelect)	Set the object to operate on.
final void	setViewPath(String viewPath)	Set the path to the item in a ClearCase view to operate on.

Methods inherited from class Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Modifier and Type	Method	Description
final void	bindToOwner(Task owner)	Bind a task to another; use this when configuring a newly created task to do work on behalf of another.
Target	getOwningTarget()	Returns the container target of this task.
RuntimeConfigurable	getRuntimeConfigurableWrapper()	Returns the wrapper used for runtime configuration.
String	getTaskName()	Returns the name to use in logging messages.
String	getTaskType()	Return the type of task.
protected RuntimeConfigurable	getWrapper()	Return the runtime configurable structure for this task.
protected void	handleErrorFlush(String output)	Handles an error line by logging it with the WARN priority.
protected void	handleErrorOutput(String output)	Handles an error output by logging it with the WARN priority.
protected void	handleFlush(String output)	Handles output by logging it with the INFO priority.
protected int	handleInput(byte[] buffer, int offset, int length)	Handle an input request by this task.
protected void	handleOutput(String output)	Handles output by logging it with the INFO priority.
void	init()	Called by the project to let the task initialize properly.
protected final boolean	isInvalid()	Has this task been marked invalid?
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	log(String msg, Throwable t, int msgLevel)	Logs a message with the given priority.
void	log(Throwable t, int msgLevel)	Logs a message with the given priority.
void	maybeConfigure()	Configures this task - if it hasn't been done already.
final void	perform()	Performs this task if it's still valid, or gets a replacement version and performs that otherwise.
void	reconfigure()	Force the task to be reconfigured from its RuntimeConfigurable.
void	setOwningTarget(Target target)	Sets the target container of this task.
void	setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)	Sets the wrapper to be used for runtime configuration.
void	setTaskName(String name)	Sets the name to use in logging messages.
void	setTaskType(String type)	Sets the name with which the task has been invoked.

Methods inherited from class ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Modifier and Type	Method	Description
Object	clone()
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FLAG_COMMENT

public static final String FLAG_COMMENT

-c flag -- comment to attach to the file

See Also:

• Constant Field Values

FLAG_COMMENTFILE

public static final String FLAG_COMMENTFILE

-cfile flag -- file containing a comment to attach to the file

See Also:

• Constant Field Values

FLAG_NOCOMMENT

public static final String FLAG_NOCOMMENT

-nc flag -- no comment is specified

See Also:

• Constant Field Values

FLAG_NOWARN

public static final String FLAG_NOWARN

-nwarn flag -- suppresses warning messages

See Also:

• Constant Field Values

FLAG_PRESERVETIME

public static final String FLAG_PRESERVETIME

-ptime flag -- preserves the modification time on checkin

See Also:

• Constant Field Values

FLAG_NOCHECKOUT

public static final String FLAG_NOCHECKOUT

-nco flag -- do not checkout element after creation

See Also:

• Constant Field Values

FLAG_CHECKIN

public static final String FLAG_CHECKIN

-ci flag -- checkin element after creation

See Also:

• Constant Field Values

FLAG_MASTER

public static final String FLAG_MASTER

-master flag -- change mastership of main branch to current site

See Also:

• Constant Field Values

FLAG_ELTYPE

public static final String FLAG_ELTYPE

-eltype flag -- element type to use during creation

See Also:

• Constant Field Values

Constructor Details

CCMkelem

public CCMkelem()

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 class Task

Throws:

BuildException - if the command fails and failonerr is set to true

setComment

public void setComment(String comment)

Sets the comment string.

Parameters:

comment - the comment string

getComment

public String getComment()

Get comment string

Returns:

String containing the comment

setCommentFile

public void setCommentFile(String cfile)

Specifies a file containing a comment.

Parameters:

cfile - the path to the comment file

getCommentFile

public String getCommentFile()

Get comment file

Returns:

String containing the path to the comment file

setNoWarn

public void setNoWarn(boolean nwarn)

If true, suppress warning messages.

Parameters:

nwarn - the status to set the flag to

getNoWarn

public boolean getNoWarn()

Get nowarn flag status

Returns:

boolean containing status of nwarn flag

setPreserveTime

public void setPreserveTime(boolean ptime)

If true, preserve the modification time.

Parameters:

ptime - the status to set the flag to

getPreserveTime

public boolean getPreserveTime()

Get preservetime flag status

Returns:

boolean containing status of preservetime flag

setNoCheckout

public void setNoCheckout(boolean co)

If true, do not checkout element after creation.

Parameters:

co - the status to set the flag to

getNoCheckout

public boolean getNoCheckout()

Get no checkout flag status

Returns:

boolean containing status of noco flag

setCheckin

public void setCheckin(boolean ci)

If true, checkin the element after creation

Parameters:

ci - the status to set the flag to

getCheckin

public boolean getCheckin()

Get ci flag status

Returns:

boolean containing status of ci flag

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

getMaster

public boolean getMaster()

Get master flag status

Returns:

boolean containing status of master flag

setEltype

public void setEltype(String eltype)

Specifies the element type to use.

Parameters:

eltype - to create element

getEltype

public String getEltype()

Get element type

Returns:

String containing the element type