Class CCLock
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.CCLock
- All Implemented Interfaces:
Cloneable
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 |
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
-comment flag -- method to use for commenting eventsstatic final String
-nusers flag -- list of users to exclude from lockstatic final String
-obsolete flag -- mark locked object as obsoletestatic final String
-pname flag -- pathname to lockstatic final String
-replace flag -- replace existing lock on object(s)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.ProjectComponent
description, location, project
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
execute()
Executes the task.Get comment methodGet nusers listGet list of objects to be lockedboolean
Get obsolete flag statusgetPname()
Get the pathname to be lockedboolean
Get replace flag statusvoid
setComment
(String comment) Sets how comments should be written for the event record(s)void
Sets the users who may continue to edit the object while it is locked.void
Sets the object(s) to be lockedvoid
setObjselect
(String objselect) Sets the object(s) to be lockedvoid
setObsolete
(boolean obsolete) If true, mark object as obsolete.void
Sets the pathname to be lockedvoid
setReplace
(boolean replace) If true, replace an existing lock.Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath
Methods inherited from class org.apache.tools.ant.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
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Field Details
-
FLAG_REPLACE
-replace flag -- replace existing lock on object(s)- See Also:
-
FLAG_NUSERS
-
FLAG_OBSOLETE
-
FLAG_COMMENT
-comment flag -- method to use for commenting events- See Also:
-
FLAG_PNAME
-
-
Constructor Details
-
CCLock
public CCLock()
-
-
Method Details
-
execute
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 classTask
- Throws:
BuildException
- if the command fails and failonerr is set to true
-
setReplace
public void setReplace(boolean replace) If true, replace an existing lock.- Parameters:
replace
- the status to set the flag to
-
getReplace
public boolean getReplace()Get replace flag status- Returns:
- boolean containing status of replace flag
-
setObsolete
public void setObsolete(boolean obsolete) If true, mark object as obsolete.- Parameters:
obsolete
- the status to set the flag to
-
getObsolete
public boolean getObsolete()Get obsolete flag status- Returns:
- boolean containing status of obsolete flag
-
setNusers
Sets the users who may continue to edit the object while it is locked.- Parameters:
nusers
- users excluded from lock
-
getNusers
Get nusers list- Returns:
- String containing the list of users excluded from lock
-
setComment
Sets how comments should be written for the event record(s)- Parameters:
comment
- comment method to use
-
getComment
-
setPname
Sets the pathname to be locked- Parameters:
pname
- pathname to be locked
-
getPname
Get the pathname to be locked- Returns:
- String containing the pathname to be locked
-
setObjSel
Sets the object(s) to be locked- Parameters:
objsel
- objects to be locked- Since:
- ant 1.6.1
-
setObjselect
Sets the object(s) to be locked- Parameters:
objselect
- objects to be locked
-
getObjselect
Get list of objects to be locked- Returns:
- String containing the objects to be locked
-