Module net.javacrumbs.shedlock.core

Package net.javacrumbs.shedlock.core

Class AbstractSimpleLock

java.lang.Object

net.javacrumbs.shedlock.core.AbstractSimpleLock

All Implemented Interfaces:

SimpleLock

public abstract class AbstractSimpleLock
extends Object
implements SimpleLock

Field Summary

Fields

Modifier and Type	Field	Description
protected final LockConfiguration	lockConfiguration

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSimpleLock(LockConfiguration lockConfiguration)

Method Summary

Modifier and Type	Method	Description
protected Optional<SimpleLock>	doExtend(LockConfiguration newConfiguration)
protected abstract void	doUnlock()
Optional<SimpleLock>	extend(Duration lockAtMostFor, Duration lockAtLeastFor)	Extends the lock.
final void	unlock()	Unlocks the lock.

Methods inherited from class java.lang.Object

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

Field Details

lockConfiguration

protected final LockConfiguration lockConfiguration

Constructor Details

AbstractSimpleLock

protected AbstractSimpleLock(LockConfiguration lockConfiguration)

Method Details

unlock

public final void unlock()

Description copied from interface: SimpleLock

Unlocks the lock. Once you unlock it, you should not use for any other operation.

Specified by:

unlock in interface SimpleLock

doUnlock

protected abstract void doUnlock()

extend

public Optional<SimpleLock> extend(Duration lockAtMostFor,
 Duration lockAtLeastFor)

Description copied from interface: SimpleLock

Extends the lock. If the lock can be extended a new lock is returned. After calling extend, no other operation can be called on current lock.

This method is NOT supported by all lock providers.

Specified by:

extend in interface SimpleLock

Returns:

a new lock or empty optional if the lock can not be extended

doExtend

protected Optional<SimpleLock> doExtend(LockConfiguration newConfiguration)