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

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 Summary

Fields

Modifier and Type	Field	Description
static final String	FLAG_COMMENT	-comment flag -- method to use for commenting events
static final String	FLAG_NUSERS	-nusers flag -- list of users to exclude from lock
static final String	FLAG_OBSOLETE	-obsolete flag -- mark locked object as obsolete
static final String	FLAG_PNAME	-pname flag -- pathname to lock
static final String	FLAG_REPLACE	-replace flag -- replace existing lock on object(s)

Fields inherited from class 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

Modifier and Type	Field	Description
static final String	COMMAND_CHECKIN	The 'Checkin' command
static final String	COMMAND_CHECKOUT	The 'Checkout' command
static final String	COMMAND_LOCK	The 'Lock' command
static final String	COMMAND_LSCO	The 'LsCheckout' command
static final String	COMMAND_MKATTR	The 'Mkattr' command
static final String	COMMAND_MKBL	The 'Mkbl' command
static final String	COMMAND_MKDIR	The 'Mkdir' command
static final String	COMMAND_MKELEM	The 'Mkelem' command
static final String	COMMAND_MKLABEL	The 'Mklabel' command
static final String	COMMAND_MKLBTYPE	The 'Mklbtype' command
static final String	COMMAND_RMTYPE	The 'Rmtype' command
static final String	COMMAND_UNCHECKOUT	The 'UndoCheckout' command
static final String	COMMAND_UNLOCK	The 'Unlock' command
static final String	COMMAND_UPDATE	The 'Update' command

Fields inherited from class Task

target, taskName, taskType, wrapper

Modifier and Type	Field	Description
protected Target	target	Deprecated. since 1.6.x.
protected String	taskName	Deprecated. since 1.6.x.
protected String	taskType	Deprecated. since 1.6.x.
protected RuntimeConfigurable	wrapper	Deprecated. since 1.6.x.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
CCLock()

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class ClearCase

getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath

Modifier and Type	Method	Description
protected final String	getClearToolCommand()	Builds and returns the command string to execute cleartool
boolean	getFailOnErr()	Get failonerr flag status
String	getObjSelect()	Get the object to operate on
String	getViewPath()	Get the path to the item in a clearcase view
String	getViewPathBasename()	Get the basename path of the item in a clearcase view
protected int	run(Commandline cmd)	Execute the given command are return success or failure
protected String	runS(Commandline cmdline)	Deprecated. use the two arg version instead
protected String	runS(Commandline cmdline, boolean failOnError)	Execute the given command, and return it's output
final void	setClearToolDir(String dir)	Set the directory where the cleartool executable is located.
void	setFailOnErr(boolean failonerr)	If true, command will throw an exception on failure.
final void	setObjSelect(String objSelect)	Set the object to operate on.
final void	setViewPath(String viewPath)	Set the path to the item in a ClearCase view to operate on.

Methods inherited from class 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

Modifier and Type	Method	Description
final void	bindToOwner(Task owner)	Bind a task to another; use this when configuring a newly created task to do work on behalf of another.
Target	getOwningTarget()	Returns the container target of this task.
RuntimeConfigurable	getRuntimeConfigurableWrapper()	Returns the wrapper used for runtime configuration.
String	getTaskName()	Returns the name to use in logging messages.
String	getTaskType()	Return the type of task.
protected RuntimeConfigurable	getWrapper()	Return the runtime configurable structure for this task.
protected void	handleErrorFlush(String output)	Handles an error line by logging it with the WARN priority.
protected void	handleErrorOutput(String output)	Handles an error output by logging it with the WARN priority.
protected void	handleFlush(String output)	Handles output by logging it with the INFO priority.
protected int	handleInput(byte[] buffer, int offset, int length)	Handle an input request by this task.
protected void	handleOutput(String output)	Handles output by logging it with the INFO priority.
void	init()	Called by the project to let the task initialize properly.
protected final boolean	isInvalid()	Has this task been marked invalid?
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	log(String msg, Throwable t, int msgLevel)	Logs a message with the given priority.
void	log(Throwable t, int msgLevel)	Logs a message with the given priority.
void	maybeConfigure()	Configures this task - if it hasn't been done already.
final void	perform()	Performs this task if it's still valid, or gets a replacement version and performs that otherwise.
void	reconfigure()	Force the task to be reconfigured from its RuntimeConfigurable.
void	setOwningTarget(Target target)	Sets the target container of this task.
void	setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)	Sets the wrapper to be used for runtime configuration.
void	setTaskName(String name)	Sets the name to use in logging messages.
void	setTaskType(String type)	Sets the name with which the task has been invoked.

Methods inherited from class ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Modifier and Type	Method	Description
Object	clone()
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FLAG_REPLACE

public static final String FLAG_REPLACE

-replace flag -- replace existing lock on object(s)

See Also:

• Constant Field Values

FLAG_NUSERS

public static final String FLAG_NUSERS

-nusers flag -- list of users to exclude from lock

See Also:

• Constant Field Values

FLAG_OBSOLETE

public static final String FLAG_OBSOLETE

-obsolete flag -- mark locked object as obsolete

See Also:

• Constant Field Values

FLAG_COMMENT

public static final String FLAG_COMMENT

-comment flag -- method to use for commenting events

See Also:

• Constant Field Values

FLAG_PNAME

public static final String FLAG_PNAME

-pname flag -- pathname to lock

See Also:

• Constant Field Values

Constructor Details

CCLock

public CCLock()

Method Details

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.

Overrides:

execute in class Task

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

public void setNusers(String nusers)

Sets the users who may continue to edit the object while it is locked.

Parameters:

nusers - users excluded from lock

getNusers

public String getNusers()

Get nusers list

Returns:

String containing the list of users excluded from lock

setComment

public void setComment(String comment)

Sets how comments should be written for the event record(s)

Parameters:

comment - comment method to use

getComment

public String getComment()

Get comment method

Returns:

String containing the desired comment method

setPname

public void setPname(String pname)

Sets the pathname to be locked

Parameters:

pname - pathname to be locked

getPname

public String getPname()

Get the pathname to be locked

Returns:

String containing the pathname to be locked

setObjSel

public void setObjSel(String objsel)

Sets the object(s) to be locked

Parameters:

objsel - objects to be locked

Since:

ant 1.6.1

setObjselect

public void setObjselect(String objselect)

Sets the object(s) to be locked

Parameters:

objselect - objects to be locked

getObjselect

public String getObjselect()

Get list of objects to be locked

Returns:

String containing the objects to be locked