Clarify that ShuffleOrder must be consistent in both directions

#minor-release

PiperOrigin-RevId: 453622964
This commit is contained in:
ibaker 2022-06-08 08:31:29 +00:00 committed by Marc Baechinger
parent 96274bfd98
commit 4a6f431f01

View File

@ -24,6 +24,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}.
*/
@UnstableApi
public interface ShuffleOrder {