org.apache.tools.ant.taskdefs.optional.clearcase
public class CCLock extends ClearCase
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 |
Field Summary | |
---|---|
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) |
Method Summary | |
---|---|
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 | setObjselect(String objselect)
Sets the object(s) to be locked
|
void | setObjSel(String objsel)
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.
|
Builds a command line to execute cleartool and then calls Exec's run method to execute the command line.
Throws: BuildException if the command fails and failonerr is set to true
Returns: String containing the desired comment method
Returns: String containing the list of users excluded from lock
Returns: String containing the objects to be locked
Returns: boolean containing status of obsolete flag
Returns: String containing the pathname to be locked
Returns: boolean containing status of replace flag
Parameters: comment comment method to use
Parameters: nusers users excluded from lock
Parameters: objselect objects to be locked
Parameters: objsel objects to be locked
Since: ant 1.6.1
Parameters: obsolete the status to set the flag to
Parameters: pname pathname to be locked
Parameters: replace the status to set the flag to