| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.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
public 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 | 
| Field Summary | |
|---|---|
| static java.lang.String | FLAG_COMMENT-comment flag -- method to use for commenting events | 
| static java.lang.String | FLAG_NUSERS-nusers flag -- list of users to exclude from lock | 
| static java.lang.String | FLAG_OBSOLETE-obsolete flag -- mark locked object as obsolete | 
| static java.lang.String | FLAG_PNAME-pname flag -- pathname to lock | 
| static java.lang.String | FLAG_REPLACE-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.Task | 
|---|
| target, taskName, taskType, wrapper | 
| Fields inherited from class org.apache.tools.ant.ProjectComponent | 
|---|
| description, location, project | 
| Constructor Summary | |
|---|---|
| CCLock() | |
| Method Summary | |
|---|---|
|  void | execute()Executes the task. | 
|  java.lang.String | getComment()Get comment method | 
|  java.lang.String | getNusers()Get nusers list | 
|  java.lang.String | getObjselect()Get list of objects to be locked | 
|  boolean | getObsolete()Get obsolete flag status | 
|  java.lang.String | getPname()Get the pathname to be locked | 
|  boolean | getReplace()Get replace flag status | 
|  void | setComment(java.lang.String comment)Sets how comments should be written for the event record(s) | 
|  void | setNusers(java.lang.String nusers)Sets the users who may continue to edit the object while it is locked. | 
|  void | setObjSel(java.lang.String objsel)Sets the object(s) to be locked | 
|  void | setObjselect(java.lang.String objselect)Sets the object(s) to be locked | 
|  void | setObsolete(boolean obsolete)If true, mark object as obsolete. | 
|  void | setPname(java.lang.String pname)Sets the pathname to be locked | 
|  void | 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, 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 | 
| Methods inherited from class java.lang.Object | 
|---|
| equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
|---|
public static final java.lang.String FLAG_REPLACE
public static final java.lang.String FLAG_NUSERS
public static final java.lang.String FLAG_OBSOLETE
public static final java.lang.String FLAG_COMMENT
public static final java.lang.String FLAG_PNAME
| Constructor Detail | 
|---|
public CCLock()
| Method Detail | 
|---|
public void execute()
             throws BuildException
Builds a command line to execute cleartool and then calls Exec's run method to execute the command line.
execute in class TaskBuildException - if the command fails and failonerr is set to truepublic void setReplace(boolean replace)
replace - the status to set the flag topublic boolean getReplace()
public void setObsolete(boolean obsolete)
obsolete - the status to set the flag topublic boolean getObsolete()
public void setNusers(java.lang.String nusers)
nusers - users excluded from lockpublic java.lang.String getNusers()
public void setComment(java.lang.String comment)
comment - comment method to usepublic java.lang.String getComment()
public void setPname(java.lang.String pname)
pname - pathname to be lockedpublic java.lang.String getPname()
public void setObjSel(java.lang.String objsel)
objsel - objects to be lockedpublic void setObjselect(java.lang.String objselect)
objselect - objects to be lockedpublic java.lang.String getObjselect()
| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||