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

Class CCMkattr


public class CCMkattr
extends ClearCase

Task to perform mkattr command to ClearCase.

The following attributes are interpreted:

AttributeValuesRequired
viewpathPath to the ClearCase view file or directory that the command will operate onYes
replaceReplace the value of the attribute if it already existsNo
recurseProcess each subdirectory under viewpathNo
versionIdentify a specific version to attach the attribute toNo
typenameName of the attribute typeYes
typevalueValue to attach to the attribute typeYes
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
failonerrThrow an exception if the command fails. Default is trueNo

Field Summary

static String
FLAG_COMMENT
-c flag -- comment to attach to the element
static String
FLAG_COMMENTFILE
-cfile flag -- file containing a comment to attach to the file
static String
FLAG_NOCOMMENT
-nc flag -- no comment is specified
static String
FLAG_RECURSE
-recurse flag -- process all subdirectories
static String
FLAG_REPLACE
-replace flag -- replace the existing value of the attribute
static String
FLAG_VERSION
-version flag -- attach attribute to specified version

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
getComment()
Get comment string
String
getCommentFile()
Get comment file
boolean
getRecurse()
Get recurse flag status
boolean
getReplace()
Get replace flag status
String
getTypeName()
Get attribute type-name
String
getTypeValue()
Get the attribute type-value
String
getVersion()
Get version flag status
void
setComment(String comment)
Set comment string
void
setCommentFile(String cfile)
Set comment file
void
setRecurse(boolean recurse)
Set recurse flag
void
setReplace(boolean replace)
Set the replace flag
void
setTypeName(String tn)
Set the attribute type-name
void
setTypeValue(String tv)
Set the attribute type-value
void
setVersion(String version)
Set the version 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 element

FLAG_COMMENTFILE

public static final String FLAG_COMMENTFILE
-cfile flag -- file containing a comment to attach to the file

FLAG_NOCOMMENT

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

FLAG_RECURSE

public static final String FLAG_RECURSE
-recurse flag -- process all subdirectories

FLAG_REPLACE

public static final String FLAG_REPLACE
-replace flag -- replace the existing value of the attribute

FLAG_VERSION

public static final String FLAG_VERSION
-version flag -- attach attribute to specified version

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

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

getRecurse

public boolean getRecurse()
Get recurse flag status
Returns:
boolean containing status of recurse flag

getReplace

public boolean getReplace()
Get replace flag status
Returns:
boolean containing status of replace flag

getTypeName

public String getTypeName()
Get attribute type-name
Returns:
String containing type name

getTypeValue

public String getTypeValue()
Get the attribute type-value
Returns:
String containing type value

getVersion

public String getVersion()
Get version flag status
Returns:
boolean containing status of version flag

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

setRecurse

public void setRecurse(boolean recurse)
Set recurse flag
Parameters:
recurse - the status to set the flag to

setReplace

public void setReplace(boolean replace)
Set the replace flag
Parameters:
replace - the status to set the flag to

setTypeName

public void setTypeName(String tn)
Set the attribute type-name
Parameters:
tn - the type name

setTypeValue

public void setTypeValue(String tv)
Set the attribute type-value
Parameters:
tv - the type value

setVersion

public void setVersion(String version)
Set the version flag
Parameters:
version - the status to set the flag to

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