| com.pnfsoftware.jeb.core.units.IUnitLock |
Known Indirect Subclasses
|
Definition of a unit model lock. Unit locks are optionally provided by units.
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract ACLock |
a(long blockTimeoutMs)
Attempt to acquire an auto-closable wrapper on this unit lock.
| ||||||||||
| abstract ACLock |
a()
Attempt to acquire an auto-closable wrapper on this unit lock.
| ||||||||||
| abstract long |
getDefaultBlockTimeoutMs()
Get the default wait time lock acquisition will block before throwing a
UnitLockedException. | ||||||||||
| abstract boolean |
isLocked()
Determine if the lock is held by _any_ thread.
| ||||||||||
| abstract boolean |
isLockedByCurrentThread()
Determine if the lock is held by _this_ thread.
| ||||||||||
| abstract void |
verifyLocked()
Verify that the lock is help by this thread, and raise an exception if not.
| ||||||||||
Attempt to acquire an auto-closable wrapper on this unit lock. If the lock cannot be acquired
within the provided time frame, the method will throw a UnitLockedException (see
getDefaultBlockTimeoutMs()).
Best-practice: This method must be called in a try-with-resources.
Attempt to acquire an auto-closable wrapper on this unit lock. If the lock cannot be acquired
within the time frame defined by getDefaultBlockTimeoutMs(), it will throw a
UnitLockedException (see getDefaultBlockTimeoutMs()).
Best-practice: This method must be called in a try-with-resources.
Get the default wait time lock acquisition will block before throwing a
UnitLockedException.
Determine if the lock is held by _any_ thread. Purely indicative, do not use for synchronization.
Determine if the lock is held by _this_ thread. Purely indicative, do not use for synchronization.
Verify that the lock is help by this thread, and raise an exception if not.
| JebRuntimeException | if the lock is not owned by the calling thread |
|---|