[
https://issues.apache.org/jira/browse/HBASE-27906?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Duo Zhang reopened HBASE-27906:
-------------------------------
> Fix the javadoc for SyncFutureCache
> -----------------------------------
>
> Key: HBASE-27906
> URL: https://issues.apache.org/jira/browse/HBASE-27906
> Project: HBase
> Issue Type: Improvement
> Components: documentation
> Reporter: Duo Zhang
> Assignee: Dimitrios Efthymiou
> Priority: Minor
> Fix For: 4.0.0-alpha-1
>
>
> 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'
> {code}
> /**
> * 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.
> */
> {code}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
