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:
- java.lang.Cloneable
 
 public class CCLock extends ClearCase Performs a ClearCase Lock command.The following attributes are interpreted: Task attributes 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 SummaryFields Modifier and Type Field Description static java.lang.StringFLAG_COMMENT-comment flag -- method to use for commenting eventsstatic java.lang.StringFLAG_NUSERS-nusers flag -- list of users to exclude from lockstatic java.lang.StringFLAG_OBSOLETE-obsolete flag -- mark locked object as obsoletestatic java.lang.StringFLAG_PNAME-pname flag -- pathname to lockstatic java.lang.StringFLAG_REPLACE-replace flag -- replace existing lock on object(s)- 
Fields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCaseCOMMAND_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.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description CCLock()
 - 
Method SummaryModifier and Type Method Description voidexecute()Executes the task.java.lang.StringgetComment()Get comment methodjava.lang.StringgetNusers()Get nusers listjava.lang.StringgetObjselect()Get list of objects to be lockedbooleangetObsolete()Get obsolete flag statusjava.lang.StringgetPname()Get the pathname to be lockedbooleangetReplace()Get replace flag statusvoidsetComment(java.lang.String comment)Sets how comments should be written for the event record(s)voidsetNusers(java.lang.String nusers)Sets the users who may continue to edit the object while it is locked.voidsetObjSel(java.lang.String objsel)Sets the object(s) to be lockedvoidsetObjselect(java.lang.String objselect)Sets the object(s) to be lockedvoidsetObsolete(boolean obsolete)If true, mark object as obsolete.voidsetPname(java.lang.String pname)Sets the pathname to be lockedvoidsetReplace(boolean replace)If true, replace an existing lock.- 
Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCasegetClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath
 - 
Methods inherited from class org.apache.tools.ant.TaskbindToOwner, 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.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
- 
 
- 
- 
- 
Field Detail- 
FLAG_REPLACEpublic static final java.lang.String FLAG_REPLACE -replace flag -- replace existing lock on object(s)- See Also:
- Constant Field Values
 
 - 
FLAG_NUSERSpublic static final java.lang.String FLAG_NUSERS -nusers flag -- list of users to exclude from lock- See Also:
- Constant Field Values
 
 - 
FLAG_OBSOLETEpublic static final java.lang.String FLAG_OBSOLETE -obsolete flag -- mark locked object as obsolete- See Also:
- Constant Field Values
 
 - 
FLAG_COMMENTpublic static final java.lang.String FLAG_COMMENT -comment flag -- method to use for commenting events- See Also:
- Constant Field Values
 
 - 
FLAG_PNAMEpublic static final java.lang.String FLAG_PNAME -pname flag -- pathname to lock- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
executepublic void execute() throws BuildExceptionExecutes the task.Builds a command line to execute cleartool and then calls Exec's run method to execute the command line. - Overrides:
- executein class- Task
- Throws:
- BuildException- if the command fails and failonerr is set to true
 
 - 
setReplacepublic void setReplace(boolean replace) If true, replace an existing lock.- Parameters:
- replace- the status to set the flag to
 
 - 
getReplacepublic boolean getReplace() Get replace flag status- Returns:
- boolean containing status of replace flag
 
 - 
setObsoletepublic void setObsolete(boolean obsolete) If true, mark object as obsolete.- Parameters:
- obsolete- the status to set the flag to
 
 - 
getObsoletepublic boolean getObsolete() Get obsolete flag status- Returns:
- boolean containing status of obsolete flag
 
 - 
setNuserspublic void setNusers(java.lang.String nusers) Sets the users who may continue to edit the object while it is locked.- Parameters:
- nusers- users excluded from lock
 
 - 
getNuserspublic java.lang.String getNusers() Get nusers list- Returns:
- String containing the list of users excluded from lock
 
 - 
setCommentpublic void setComment(java.lang.String comment) Sets how comments should be written for the event record(s)- Parameters:
- comment- comment method to use
 
 - 
getCommentpublic java.lang.String getComment() Get comment method- Returns:
- String containing the desired comment method
 
 - 
setPnamepublic void setPname(java.lang.String pname) Sets the pathname to be locked- Parameters:
- pname- pathname to be locked
 
 - 
getPnamepublic java.lang.String getPname() Get the pathname to be locked- Returns:
- String containing the pathname to be locked
 
 - 
setObjSelpublic void setObjSel(java.lang.String objsel) Sets the object(s) to be locked- Parameters:
- objsel- objects to be locked
- Since:
- ant 1.6.1
 
 - 
setObjselectpublic void setObjselect(java.lang.String objselect) Sets the object(s) to be locked- Parameters:
- objselect- objects to be locked
 
 - 
getObjselectpublic java.lang.String getObjselect() Get list of objects to be locked- Returns:
- String containing the objects to be locked
 
 
- 
 
-