Uploaded image for project: 'HBase'
  1. HBase
  2. HBASE-27906

Fix the javadoc for SyncFutureCache

    XMLWordPrintableJSON

Details

    • Reviewed

    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.
       */
      

      Attachments

        Issue Links

          Activity

            People

              dimitrios.efthymiou Dimitrios Efthymiou
              zhangduo Duo Zhang
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: