[HBASE-27906] Fix the javadoc for SyncFutureCache

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 2.6.0, 2.4.18, 2.5.6, 3.0.0-beta-1
• Component/s: documentation
• Hadoop Flags: Reviewed
• Assignee: Dimitrios Efthymiou
• Reporter: Duo Zhang
• Created: 03/Jun/23 13:43
• Updated: 21/Jul/23 18:30
• Resolved: 20/Jul/23 13:49

Description

It does not have any html markers so spotless messed it up...

We should add html markers so it could keep the format after 'spotless:apply'

/**
 * A cache of {@link SyncFuture}s. This class supports two methods
 * {@link SyncFutureCache#getIfPresentOrNew()} and {@link SyncFutureCache#offer()}.
 * <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.
 */

Issue Links

• links to: GitHub Pull Request #5325