ShuffleOrder (library-core API)

All Known Implementing Classes:

ShuffleOrder.DefaultShuffleOrder, ShuffleOrder.UnshuffledShuffleOrder
```
public interface ShuffleOrder
```
Shuffled order of indices.
The shuffle order must be immutable to ensure thread safety.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ShuffleOrder.DefaultShuffleOrder` The default `ShuffleOrder` implementation for random shuffle order.
`static class`	`ShuffleOrder.UnshuffledShuffleOrder` A `ShuffleOrder` implementation which does not shuffle.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ShuffleOrder`	`cloneAndClear()` Returns a copy of the shuffle order with all elements removed.
`ShuffleOrder`	`cloneAndInsert(int insertionIndex, int insertionCount)` Returns a copy of the shuffle order with newly inserted elements.
`ShuffleOrder`	`cloneAndRemove(int removalIndex)` Returns a copy of the shuffle order with one element removed.
`int`	`getFirstIndex()` Returns the first index in the shuffle order, or `C.INDEX_UNSET` if the shuffle order is empty.
`int`	`getLastIndex()` Returns the last index in the shuffle order, or `C.INDEX_UNSET` if the shuffle order is empty.
`int`	`getLength()` Returns length of shuffle order.
`int`	`getNextIndex(int index)` Returns the next index in the shuffle order.
`int`	`getPreviousIndex(int index)` Returns the previous index in the shuffle order.

- Method Detail
  - getLength
```
int getLength()
```
    Returns length of shuffle order.
  - getNextIndex
```
int getNextIndex(int index)
```
    Returns the next index in the shuffle order.
    
    Parameters:
    
    index - An index.
    
    Returns:
    
    The index after index, or C.INDEX_UNSET if index is the last element.
  - getPreviousIndex
```
int getPreviousIndex(int index)
```
    Returns the previous index in the shuffle order.
    
    Parameters:
    
    index - An index.
    
    Returns:
    
    The index before index, or C.INDEX_UNSET if index is the first element.
  - getLastIndex
```
int getLastIndex()
```
    Returns the last index in the shuffle order, or C.INDEX_UNSET if the shuffle order is empty.
  - getFirstIndex
```
int getFirstIndex()
```
    Returns the first index in the shuffle order, or C.INDEX_UNSET if the shuffle order is empty.
  - cloneAndInsert
```
ShuffleOrder cloneAndInsert(int insertionIndex,
                            int insertionCount)
```
    Returns a copy of the shuffle order with newly inserted elements.
    
    Parameters:
    
    insertionIndex - The index in the unshuffled order at which elements are inserted.
    
    insertionCount - The number of elements inserted at insertionIndex.
    
    Returns:
    
    A copy of this ShuffleOrder with newly inserted elements.
  - cloneAndRemove
```
ShuffleOrder cloneAndRemove(int removalIndex)
```
    Returns a copy of the shuffle order with one element removed.
    
    Parameters:
    
    removalIndex - The index of the element in the unshuffled order which is to be removed.
    
    Returns:
    
    A copy of this ShuffleOrder without the removed element.
  - cloneAndClear
```
ShuffleOrder cloneAndClear()
```
    Returns a copy of the shuffle order with all elements removed.

Interface ShuffleOrder

Nested Class Summary

Method Summary

Method Detail

getLength

getNextIndex

getPreviousIndex

getLastIndex

getFirstIndex

cloneAndInsert

cloneAndRemove

cloneAndClear