Skip to content

Commit

Permalink
Fix #12308 with improved javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
gregw committed Nov 1, 2024
1 parent 1baf95f commit fc78e15
Showing 1 changed file with 5 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,11 @@ private void onTimeoutExpired()
}

/**
* <p>Manages the timeout of a new entity.</p>
*
* <p>Schedules a timeout for a new or modified item.</p>
* <p>If an item returned by the {@link #iterator()} has been modified or added so that it may
* now be the earliest expiring item, then this method should be called to schedule the timeout. This need not be called
* for a recurrent timeout during {@link Expirable#onTimeoutExpired()}, nor if the timeout of an existing item is increased.
* However, it is safe and inexpensive to always call this when modifying an items expiry.</p>
* @param expirable the new entity to manage the timeout for
*/
public void schedule(T expirable)
Expand Down

0 comments on commit fc78e15

Please sign in to comment.