Skip to content

Commit

Permalink
HBASE-27906 Fix the javadoc for SyncFutureCache (#5325)
Browse files Browse the repository at this point in the history
(cherry picked from commit 2c92e6f)
  • Loading branch information
orionlibs authored and Apache9 committed Jul 20, 2023
1 parent f670fe6 commit a0c5c8e
Showing 1 changed file with 14 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,20 @@

/**
* A cache of {@link SyncFuture}s. This class supports two methods
* {@link SyncFutureCache#getIfPresentOrNew()} and {@link SyncFutureCache#offer(SyncFuture)}. Usage
* pattern: SyncFuture sf = syncFutureCache.getIfPresentOrNew(); sf.reset(...); // Use the sync
* future finally: syncFutureCache.offer(sf); Offering the sync future back to the cache makes it
* eligible for reuse within the same thread context. Cache keyed by the accessing thread instance
* and automatically invalidated if it remains unused for
* {@link SyncFutureCache#SYNC_FUTURE_INVALIDATION_TIMEOUT_MINS} minutes.
* {@link SyncFutureCache#getIfPresentOrNew()} and {@link SyncFutureCache#offer(SyncFuture)}}.
* <p>
* Usage pattern:
*
* <pre>
* SyncFuture sf = syncFutureCache.getIfPresentOrNew();
* sf.reset(...);
* // Use the sync future
* finally: syncFutureCache.offer(sf);
* </pre>
*
* Offering the sync future back to the cache makes it eligible for reuse within the same thread
* context. Cache keyed by the accessing thread instance and automatically invalidated if it remains
* unused for {@link SyncFutureCache#SYNC_FUTURE_INVALIDATION_TIMEOUT_MINS} minutes.
*/
@InterfaceAudience.Private
public final class SyncFutureCache {
Expand Down

0 comments on commit a0c5c8e

Please sign in to comment.