Package sonia.scm.repository.api

Class FileLockCommandBuilder.InnerUnlockCommandBuilder

java.lang.Object

sonia.scm.repository.api.FileLockCommandBuilder.InnerUnlockCommandBuilder

Enclosing class:

FileLockCommandBuilder

public class FileLockCommandBuilder.InnerUnlockCommandBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
InnerUnlockCommandBuilder(String file)

Method Summary

Modifier and Type	Method	Description
UnlockCommandResult	execute()	Remove the lock.
FileLockCommandBuilder.InnerUnlockCommandBuilder	force()	Set the command to force unlock.
FileLockCommandBuilder.InnerUnlockCommandBuilder	force(boolean force)	Set whether to force unlock or not.

Methods inherited from class java.lang.Object

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

Constructor Details

InnerUnlockCommandBuilder

public InnerUnlockCommandBuilder(String file)

Method Details

force

public FileLockCommandBuilder.InnerUnlockCommandBuilder force()

Set the command to force unlock. Shortcut for force(true).

Returns:

This builder instance.

See Also:

• force(boolean)

force

public FileLockCommandBuilder.InnerUnlockCommandBuilder force(boolean force)

Set whether to force unlock or not. A lock from a different user can only be removed with force set to true.

Parameters:

force - Whether to force unlock or not.

Returns:

This builder instance.

execute

public UnlockCommandResult execute()

Remove the lock.

Returns:

The result of the lock removal.

Throws:

FileLockedException - if the file is locked by another user and force(boolean) has not been set to true.