Package sonia.scm.repository.api

Class FileLockCommandBuilder

java.lang.Object

sonia.scm.repository.api.FileLockCommandBuilder

public final class FileLockCommandBuilder
extends Object

Can lock and unlock files and check lock states. Locked files can only be modified by the user holding the lock.

Since:

2.26.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	FileLockCommandBuilder.InnerLockCommandBuilder
class	FileLockCommandBuilder.InnerUnlockCommandBuilder

Constructor Summary

Constructors

Constructor	Description
FileLockCommandBuilder(FileLockCommand fileLockCommand, Repository repository)

Method Summary

Modifier and Type	Method	Description
Collection<FileLock>	getAll()	Retrieves all locks for the repository.
FileLockCommandBuilder.InnerLockCommandBuilder	lock(String file)	Creates builder to lock the given file.
Optional<FileLock>	status(String file)	Retrieves the lock for a file, if it is locked.
FileLockCommandBuilder.InnerUnlockCommandBuilder	unlock(String file)	Creates builder to unlock the given file.

Methods inherited from class java.lang.Object

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

Constructor Details

FileLockCommandBuilder

public FileLockCommandBuilder(FileLockCommand fileLockCommand,
 Repository repository)

Method Details

lock

public FileLockCommandBuilder.InnerLockCommandBuilder lock(String file)

Creates builder to lock the given file.

Parameters:

file - The file to lock.

Returns:

Builder for lock creation.

unlock

public FileLockCommandBuilder.InnerUnlockCommandBuilder unlock(String file)

Creates builder to unlock the given file.

Parameters:

file - The file to unlock.

Returns:

Builder to unlock a file.

status

public Optional<FileLock> status(String file)

Retrieves the lock for a file, if it is locked.

Parameters:

file - The file to get the lock for.

Returns:

Optional with the lock, if the file is locked, or Optional.empty(), if the file is not locked

getAll

public Collection<FileLock> getAll()

Retrieves all locks for the repository.

Returns:

Collection of all locks for the repository.