Clarify that ShuffleOrder must be consistent in both directions

#minor-release

PiperOrigin-RevId: 453622964
(cherry picked from commit 2c2be2da92b5cbefa81e5960d7f39f01979a2a78)
This commit is contained in:
ibaker 2022-06-08 08:31:29 +00:00 committed by Marc Baechinger
parent 68054de481
commit 2e2bbdd7b5

View File

@ -23,6 +23,9 @@ import java.util.Random;
* Shuffled order of indices.
*
* <p>The shuffle order must be immutable to ensure thread safety.
*
* <p>The order must be consistent when traversed both {@linkplain #getNextIndex(int) forwards} and
* {@linkplain #getPreviousIndex(int) backwards}.
*/
public interface ShuffleOrder {