Class CCMkbl

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.CCMkbl

All Implemented Interfaces:

Cloneable

public class CCMkbl
extends ClearCase

Task to CreateBaseline command to ClearCase.

The following attributes are interpreted:

Task attributes

Attribute	Values	Required
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
baselinerootname	Specify the name to be associated with the baseline.	Yes
nowarn	Suppress warning messages	No
identical	Allows the baseline to be created even if it is identical to the previous baseline.	No
full	Creates a full baseline.	No
nlabel	Allows the baseline to be created without a label.	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_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_FULL	-full flag -- baseline to be created is full
static final String	FLAG_IDENTICAL	-identical flag -- allows the file to be checked in even if it is identical to the original
static final String	FLAG_INCREMENTAL	-incremental flag -- baseline to be created is incremental
static final String	FLAG_NLABEL	-nlabel -- baseline to be created without a label
static final String	FLAG_NOCOMMENT	-nc flag -- no comment is specified

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

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the task.
String	getBaselineRootName()	Get baseline_root_name
String	getComment()	Get comment string
String	getCommentFile()	Get comment file
boolean	getFull()	Get full flag status
boolean	getIdentical()	Get identical flag status
boolean	getNlabel()	Get nlabel status
boolean	getNoWarn()	Get nowarn flag status
void	setBaselineRootName(String baselineRootName)	Set baseline_root_name
void	setComment(String comment)	Set comment string
void	setCommentFile(String cfile)	Set comment file
void	setFull(boolean full)	Set the full flag
void	setIdentical(boolean identical)	Set the identical flag
void	setNlabel(boolean nlabel)	Set the nlabel flag
void	setNoWarn(boolean nwarn)	Set the nowarn flag

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_IDENTICAL

public static final String FLAG_IDENTICAL

-identical flag -- allows the file to be checked in even if it is identical to the original

See Also:

• Constant Field Values

FLAG_INCREMENTAL

public static final String FLAG_INCREMENTAL

-incremental flag -- baseline to be created is incremental

See Also:

• Constant Field Values

FLAG_FULL

public static final String FLAG_FULL

-full flag -- baseline to be created is full

See Also:

• Constant Field Values

FLAG_NLABEL

public static final String FLAG_NLABEL

-nlabel -- baseline to be created without a label

See Also:

• Constant Field Values

Constructor Details

CCMkbl

public CCMkbl()

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)

Set 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)

Set comment file

Parameters:

cfile - the path to the comment file

getCommentFile

public String getCommentFile()

Get comment file

Returns:

String containing the path to the comment file

setBaselineRootName

public void setBaselineRootName(String baselineRootName)

Set baseline_root_name

Parameters:

baselineRootName - the name of the baseline

getBaselineRootName

public String getBaselineRootName()

Get baseline_root_name

Returns:

String containing the name of the baseline

setNoWarn

public void setNoWarn(boolean nwarn)

Set the nowarn flag

Parameters:

nwarn - the status to set the flag to

getNoWarn

public boolean getNoWarn()

Get nowarn flag status

Returns:

boolean containing status of nwarn flag

setIdentical

public void setIdentical(boolean identical)

Set the identical flag

Parameters:

identical - the status to set the flag to

getIdentical

public boolean getIdentical()

Get identical flag status

Returns:

boolean containing status of identical flag

setFull

public void setFull(boolean full)

Set the full flag

Parameters:

full - the status to set the flag to

getFull

public boolean getFull()

Get full flag status

Returns:

boolean containing status of full flag

setNlabel

public void setNlabel(boolean nlabel)

Set the nlabel flag

Parameters:

nlabel - the status to set the flag to

getNlabel

public boolean getNlabel()

Get nlabel status

Returns:

boolean containing status of nlabel flag