Package org.tmatesoft.svn.core.wc2
Class SvnSetLock
java.lang.Object
- All Implemented Interfaces:
ISvnObjectReceiver<SVNLock>
,ISvnOperationOptionsProvider
Represents operation for locking files.
Locks file items in a working copy as well as in a repository so that
no other user can commit changes to them.
SvnOperation.run()
method returns SVNLock
object that represents information of lock.
SvnOperation.run()
method throws SVNException
if one of the following is true:
- a
target
's path to be locked is not under version control - can not obtain a URL of a local
target
's path to lock it in the repository - there's no such entry targets
to be locked belong to different repositories ((for SVN 1.6 working copy only)
- Version:
- 1.7
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionjava.lang.String
Gets the optional comment for the lock.protected int
boolean
Gets whether the operation changes working copyboolean
Gets whether or not all existing locks on the specified targets will be "stolen" from another user or working copy.void
setLockMessage
(java.lang.String lockMessage) Sets the optional comment for the lock.void
setStealLock
(boolean stealLock) Sets whether or not all existing locks on the specified targets will be "stolen" from another user or working copy.Methods inherited from class org.tmatesoft.svn.core.wc2.SvnReceivingOperation
first, getReceiver, initDefaults, last, receive, run, setReceiver
Methods inherited from class org.tmatesoft.svn.core.wc2.SvnOperation
addTarget, cancel, ensureArgumentsAreValid, ensureEnoughTargets, ensureHomohenousTargets, getApplicableChangelists, getAuthenticationManager, getCanceller, getDepth, getEventHandler, getFirstTarget, getMinimumTargetsCount, getOperationalWorkingCopy, getOperationFactory, getOptions, getRepositoryPool, getRevision, getSqliteJournalMode, getTargets, hasFileTargets, hasLocalTargets, hasRemoteTargets, isCancelled, isSleepForTimestamp, isUseParentWcFormat, needsHomohenousTargets, run, setApplicalbeChangelists, setDepth, setRevision, setSingleTarget, setSleepForTimestamp, setSqliteJournalMode
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
stealLock
private boolean stealLock -
lockMessage
private java.lang.String lockMessage
-
-
Constructor Details
-
SvnSetLock
-
-
Method Details
-
isStealLock
public boolean isStealLock()Gets whether or not all existing locks on the specified targets will be "stolen" from another user or working copy.- Returns:
true
if locks should be "stolen", otherwisefalse
-
setStealLock
public void setStealLock(boolean stealLock) Sets whether or not all existing locks on the specified targets will be "stolen" from another user or working copy.- Parameters:
stealLock
-true
if locks should be "stolen", otherwisefalse
-
getLockMessage
public java.lang.String getLockMessage()Gets the optional comment for the lock.- Returns:
- comment for the lock
-
setLockMessage
public void setLockMessage(java.lang.String lockMessage) Sets the optional comment for the lock.- Parameters:
lockMessage
- comment for the lock
-
getMaximumTargetsCount
protected int getMaximumTargetsCount()- Overrides:
getMaximumTargetsCount
in classSvnOperation<SVNLock>
-
isChangesWorkingCopy
public boolean isChangesWorkingCopy()Gets whether the operation changes working copy- Overrides:
isChangesWorkingCopy
in classSvnOperation<SVNLock>
- Returns:
true
if the operation changes the working copy, otherwisefalse
-