org.apache.tools.ant.taskdefs.optional.clearcase
Class CCLock
Performs a ClearCase Lock command.
The following attributes are interpreted:
Attribute | Values | Required |
---|
replace | Specifies replacing an existing lock | No |
|
nusers | Specifies user(s) who can still modify the object/pname | No |
|
obsolete | Specifies that the object/pname should be marked obsolete | No |
|
comment | Specifies how to populate comments fields | No |
|
pname | Specifies the pathname to be locked. | No |
objselect | This variable is obsolete. Should use objsel instead. | No |
|
objsel | Specifies the object(s) to be unlocked. | No |
|
failonerr | Throw an exception if the command fails. Default is true | No |
|
static String | FLAG_COMMENT - -comment flag -- method to use for commenting events
|
static String | FLAG_NUSERS - -nusers flag -- list of users to exclude from lock
|
static String | FLAG_OBSOLETE - -obsolete flag -- mark locked object as obsolete
|
static String | FLAG_PNAME - -pname flag -- pathname to lock
|
static String | FLAG_REPLACE - -replace flag -- replace existing lock on object(s)
|
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 |
void | execute() - Executes the task.
|
String | getComment() - Get comment method
|
String | getNusers() - Get nusers list
|
String | getObjselect() - Get list of objects to be locked
|
boolean | getObsolete() - Get obsolete flag status
|
String | getPname() - Get the pathname to be locked
|
boolean | getReplace() - Get replace flag status
|
void | setComment(String comment) - Sets how comments should be written
for the event record(s)
|
void | setNusers(String nusers) - Sets the users who may continue to
edit the object while it is locked.
|
void | setObjSel(String objsel) - Sets the object(s) to be locked
|
void | setObjselect(String objselect) - Sets the object(s) to be locked
|
void | setObsolete(boolean obsolete) - If true, mark object as obsolete.
|
void | setPname(String pname) - Sets the pathname to be locked
|
void | setReplace(boolean replace) - If true, replace an existing lock.
|
getClearToolCommand , getFailOnErr , getObjSelect , getViewPath , getViewPathBasename , run , runS , setClearToolDir , setFailOnErr , setObjSelect , setViewPath |
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 |
FLAG_COMMENT
public static final String FLAG_COMMENT
-comment flag -- method to use for commenting events
FLAG_NUSERS
public static final String FLAG_NUSERS
-nusers flag -- list of users to exclude from lock
FLAG_OBSOLETE
public static final String FLAG_OBSOLETE
-obsolete flag -- mark locked object as obsolete
FLAG_PNAME
public static final String FLAG_PNAME
-pname flag -- pathname to lock
FLAG_REPLACE
public static final String FLAG_REPLACE
-replace flag -- replace existing lock on object(s)
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.
- execute in interface Task
getComment
public String getComment()
Get comment method
- String containing the desired comment method
getNusers
public String getNusers()
Get nusers list
- String containing the list of users excluded from lock
getObjselect
public String getObjselect()
Get list of objects to be locked
- String containing the objects to be locked
getObsolete
public boolean getObsolete()
Get obsolete flag status
- boolean containing status of obsolete flag
getPname
public String getPname()
Get the pathname to be locked
- String containing the pathname to be locked
getReplace
public boolean getReplace()
Get replace flag status
- boolean containing status of replace flag
setComment
public void setComment(String comment)
Sets how comments should be written
for the event record(s)
comment
- comment method to use
setNusers
public void setNusers(String nusers)
Sets the users who may continue to
edit the object while it is locked.
nusers
- users excluded from lock
setObjSel
public void setObjSel(String objsel)
Sets the object(s) to be locked
objsel
- objects to be locked
setObjselect
public void setObjselect(String objselect)
Sets the object(s) to be locked
objselect
- objects to be locked
setObsolete
public void setObsolete(boolean obsolete)
If true, mark object as obsolete.
obsolete
- the status to set the flag to
setPname
public void setPname(String pname)
Sets the pathname to be locked
pname
- pathname to be locked
setReplace
public void setReplace(boolean replace)
If true, replace an existing lock.
replace
- the status to set the flag to
Copyright B) 2000-2006 Apache Software Foundation. All Rights Reserved.