Module org.cryptomator.frontend.fuse

Package org.cryptomator.frontend.fuse.locks

Record Class PathLock

java.lang.Object

java.lang.Record

org.cryptomator.frontend.fuse.locks.PathLock

Record Components:

pathComponents - The path, split into path components

parent - The corresponding path lock for the parent path

rwLock - The read-write-lock. We need to store a strong reference while in use, because LockManager works with weeak references

lock - Either the rwLock's read or its write lock

dataLockSupplier - A supplier for a separate ReadWriteLock (not rwLock) to be used during lockDataForReading() and lockDataForWriting()

All Implemented Interfaces:

AutoCloseable

public record PathLock(@Unmodifiable List<String> pathComponents, @Nullable PathLock parent, ReadWriteLock rwLock, Lock lock, Supplier<ReadWriteLock> dataLockSupplier)
extends Record
implements AutoCloseable

A path lock, either for reading (shared) or writing (exclusive).

Constructor Summary

Constructors

Constructor	Description
PathLock(@Unmodifiable List<String> pathComponents, @Nullable PathLock parent, ReadWriteLock rwLock, Lock lock, Supplier<ReadWriteLock> dataLockSupplier)	Creates an instance of a PathLock record class.

Method Summary

Modifier and Type	Method	Description
void	close()
Supplier<ReadWriteLock>	dataLockSupplier()	Returns the value of the dataLockSupplier record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Lock	lock()	Returns the value of the lock record component.
DataLock	lockDataForReading()
DataLock	lockDataForWriting()
@Nullable PathLock	parent()	Returns the value of the parent record component.
@Unmodifiable List<String>	pathComponents()	Returns the value of the pathComponents record component.
ReadWriteLock	rwLock()	Returns the value of the rwLock record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PathLock

public PathLock(@Unmodifiable List<String> pathComponents,
 @Nullable
 @Nullable PathLock parent,
 ReadWriteLock rwLock,
 Lock lock,
 Supplier<ReadWriteLock> dataLockSupplier)

Creates an instance of a PathLock record class.

Parameters:

pathComponents - the value for the pathComponents record component

parent - the value for the parent record component

rwLock - the value for the rwLock record component

lock - the value for the lock record component

dataLockSupplier - the value for the dataLockSupplier record component

Method Details

lockDataForReading

public DataLock lockDataForReading()

lockDataForWriting

public DataLock lockDataForWriting()

close

public void close()

Specified by:

close in interface AutoCloseable

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

pathComponents

public @Unmodifiable List<String> pathComponents()

Returns the value of the pathComponents record component.

Returns:

the value of the pathComponents record component

parent

@Nullable
public @Nullable PathLock parent()

Returns the value of the parent record component.

Returns:

the value of the parent record component

rwLock

public ReadWriteLock rwLock()

Returns the value of the rwLock record component.

Returns:

the value of the rwLock record component

lock

public Lock lock()

Returns the value of the lock record component.

Returns:

the value of the lock record component

dataLockSupplier

public Supplier<ReadWriteLock> dataLockSupplier()

Returns the value of the dataLockSupplier record component.

Returns:

the value of the dataLockSupplier record component