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

Class CCMkbl


public class CCMkbl
extends ClearCase

Task to CreateBaseline command to ClearCase.

The following attributes are interpreted:

AttributeValuesRequired
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
baselinerootnameSpecify the name to be associated with the baseline.Yes
nowarnSuppress warning messagesNo
identicalAllows the baseline to be created even if it is identical to the previous baseline.No
fullCreates a full baseline.No
nlabelAllows the baseline to be created without a label.No
failonerrThrow an exception if the command fails. Default is trueNo

Field Summary

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_FULL
-full flag -- baseline to be created is full
static String
FLAG_IDENTICAL
-identical flag -- allows the file to be checked in even if it is identical to the original
static String
FLAG_INCREMENTAL
-incremental flag -- baseline to be created is incremental
static String
FLAG_NLABEL
-nlabel -- baseline to be created without a label
static String
FLAG_NOCOMMENT
-nc flag -- no comment is specified

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.
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 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_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_FULL

public static final String FLAG_FULL
-full flag -- baseline to be created is full

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

FLAG_INCREMENTAL

public static final String FLAG_INCREMENTAL
-incremental flag -- baseline to be created is incremental

FLAG_NLABEL

public static final String FLAG_NLABEL
-nlabel -- baseline to be created without a label

FLAG_NOCOMMENT

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

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

getBaselineRootName

public String getBaselineRootName()
Get baseline_root_name
Returns:
String containing the name of the baseline

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

getFull

public boolean getFull()
Get full flag status
Returns:
boolean containing status of full flag

getIdentical

public boolean getIdentical()
Get identical flag status
Returns:
boolean containing status of identical flag

getNlabel

public boolean getNlabel()
Get nlabel status
Returns:
boolean containing status of nlabel flag

getNoWarn

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

setBaselineRootName

public void setBaselineRootName(String baselineRootName)
Set baseline_root_name
Parameters:
baselineRootName - the name of the baseline

setComment

public void setComment(String comment)
Set comment string
Parameters:
comment - the comment string

setCommentFile

public void setCommentFile(String cfile)
Set comment file
Parameters:
cfile - the path to the comment file

setFull

public void setFull(boolean full)
Set the full flag
Parameters:
full - the status to set the flag to

setIdentical

public void setIdentical(boolean identical)
Set the identical flag
Parameters:
identical - the status to set the flag to

setNlabel

public void setNlabel(boolean nlabel)
Set the nlabel flag
Parameters:
nlabel - the status to set the flag to

setNoWarn

public void setNoWarn(boolean nwarn)
/** Set the nowarn flag
Parameters:
nwarn - the status to set the flag to

Copyright B) 2000-2006 Apache Software Foundation. All Rights Reserved.