- time
- the maximum time to wait for the lock
- unit
- the time unit of the time argument
Documentation for this section has not yet been entered.
Type Reason Java.Lang.InterruptedException if the current thread is interrupted while acquiring the lock (and interruption of lock acquisition is supported)
Acquires the lock if it is free within the given waiting time and the current thread has not been Java.Lang.Thread.Interrupt.
If the lock is available this method returns immediately with the value true. If the lock is not available then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of three things happens:
If the lock is acquired then the value true is returned.
If the current thread:
If the specified waiting time elapses then the value false is returned. If the time is less than or equal to zero, the method will not wait at all.
Implementation Considerations
The ability to interrupt a lock acquisition in some implementations may not be possible, and if possible may be an expensive operation. The programmer should be aware that this may be the case. An implementation should document when this is the case.
An implementation can favor responding to an interrupt over normal method return, or reporting a timeout.
A Lock implementation may be able to detect erroneous use of the lock, such as an invocation that would cause deadlock, and may throw an (unchecked) exception in such circumstances. The circumstances and the exception type must be documented by that Lock implementation.