Add a javadoc hint to for when to implement a custom scheduler (fixes #…

…1449)
ben-manes · Jan 18, 2024 · c3db61d · c3db61d
1 parent 4c20aa3
commit c3db61d
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/caffeine/src/main/java/com/github/benmanes/caffeine/cache/Scheduler.java b/caffeine/src/main/java/com/github/benmanes/caffeine/cache/Scheduler.java
@@ -66,6 +66,10 @@ static Scheduler systemScheduler() {
 
   /**
    * Returns a scheduler that delegates to the a {@link ScheduledExecutorService}.
+   * <p>
+   * Note that this implementation will ignore scheduling the task if the executor was shutdown or
+   * the submission was rejected. Consider implementing your own adapter if different behavior is
+   * required.
    *
    * @param scheduledExecutorService the executor to schedule on
    * @return a scheduler that delegates to the a {@link ScheduledExecutorService}