Java Utils 0.8.0b · io.github.darvil.utils.LoopPool · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private int	index
private final @NotNull T[]	pool

Access	Constructor and Description
private	LoopPool(int startAt, @NotNull T... pool)

Method Summary

Modifier and Type	Method and Description
public T	Returns: The element at the given relative index. at(int The relative index. relativeIndex) Returns the element at the given relative index.
public static < The type of the elements. T> LoopPool<T>	Returns: A new `LoopPool` with the given elements. atRandomIndex(T... The elements to loop through. pool) Creates a new `LoopPool` with the given elements.
public T	Returns: The current element in the sequence. current() Returns the current element in the sequence.
public int	Returns: The internal index. getIndex() Returns the internal index.
private int	Returns: A valid index to use in the pool array. getValidIndex(int The index to validate. index) Returns a valid index to use in the pool array.
public T	Returns: The next element in the sequence. next() Returns the next element in the sequence and increments the internal index.
public static < The type of the elements. T> LoopPool<T>	Returns: A new `LoopPool` with the given elements. of(T... The elements to loop through. pool) Creates a new `LoopPool` with the given elements.
public static < The type of the elements. T> LoopPool<T>	Returns: A new `LoopPool` with the given elements. of(int The index to start at. startAt, T... The elements to loop through. pool) Creates a new `LoopPool` with the given elements.
public T	Returns: The previous element in the sequence. prev() Returns the previous element in the sequence and decrements the internal index.
public void	setIndex(int The index to set. index) Sets the internal index to the given index.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

index	back to summary
private int index

pool	back to summary
private final @NotNull T[] pool

LoopPool	back to summary
private LoopPool(int startAt, @NotNull T... pool) Annotations @SafeVarargs

Method Detail

at	back to summary
public T at(int relativeIndex) Returns the element at the given relative index. The index is relative to the internal index. Parameters relativeIndex:int The relative index. Returns:T The element at the given relative index.

back to summary

public T at(int relativeIndex)

Returns the element at the given relative index. The index is relative to the internal index.

Parameters

relativeIndex:int: The relative index.

Returns:T

The element at the given relative index.

atRandomIndex back to summary

atRandomIndex	back to summary
public static <T> LoopPool<T> atRandomIndex(T... pool) Creates a new `LoopPool` with the given elements. The index will start at a random index between 0 and the number of elements provided. Parameters <T> The type of the elements. pool:T[] The elements to loop through. Returns:LoopPool<T> A new `LoopPool` with the given elements. Annotations @SafeVarargs

public static <T> LoopPool<T> atRandomIndex(T... pool)

Creates a new LoopPool with the given elements. The index will start at a random index between 0 and the number of elements provided.

Parameters

<T>: The type of the elements.
pool:T[]: The elements to loop through.

Returns:LoopPool<T>

A new LoopPool with the given elements.

Annotations

@SafeVarargs

current	back to summary
public T current() Returns the current element in the sequence. Returns:T The current element in the sequence.

current

back to summary

public T current()

Returns the current element in the sequence.

Returns:T: The current element in the sequence.

getIndex	back to summary
public int getIndex() Returns the internal index. Returns:int The internal index.

getIndex

back to summary

public int getIndex()

Returns the internal index.

Returns:int: The internal index.

getValidIndex	back to summary
private int getValidIndex(int index) Returns a valid index to use in the pool array. If the index goes out of bounds, it will always wrap around. Parameters index:int The index to validate. Returns:int A valid index to use in the pool array.

getValidIndex

back to summary

private int getValidIndex(int index)

Returns a valid index to use in the pool array. If the index goes out of bounds, it will always wrap around.

Parameters

index:int: The index to validate.

Returns:int

A valid index to use in the pool array.

next	back to summary
public T next() Returns the next element in the sequence and increments the internal index. Returns:T The next element in the sequence.

back to summary

public T next()

Returns the next element in the sequence and increments the internal index.

Returns:T: The next element in the sequence.

of back to summary

of	back to summary
public static <T> LoopPool<T> of(T... pool) Creates a new `LoopPool` with the given elements. The index will start at 0. Parameters <T> The type of the elements. pool:T[] The elements to loop through. Returns:LoopPool<T> A new `LoopPool` with the given elements. Annotations @SafeVarargs

public static <T> LoopPool<T> of(T... pool)

Creates a new LoopPool with the given elements. The index will start at 0.

Parameters

<T>: The type of the elements.
pool:T[]: The elements to loop through.

Returns:LoopPool<T>

A new LoopPool with the given elements.

Annotations

@SafeVarargs

of back to summary

of	back to summary
public static <T> LoopPool<T> of(int startAt, T... pool) Creates a new `LoopPool` with the given elements. The index will start at the given index. Parameters <T> The type of the elements. startAt:int The index to start at. pool:T[] The elements to loop through. Returns:LoopPool<T> A new `LoopPool` with the given elements. Annotations @SafeVarargs

public static <T> LoopPool<T> of(int startAt, T... pool)

Creates a new LoopPool with the given elements. The index will start at the given index.

Parameters

<T>: The type of the elements.
startAt:int: The index to start at.
pool:T[]: The elements to loop through.

Returns:LoopPool<T>

A new LoopPool with the given elements.

Annotations

@SafeVarargs

prev	back to summary
public T prev() Returns the previous element in the sequence and decrements the internal index. Returns:T The previous element in the sequence.

back to summary

public T prev()

Returns the previous element in the sequence and decrements the internal index.

Returns:T: The previous element in the sequence.

setIndex	back to summary
public void setIndex(int index) Sets the internal index to the given index. If the index goes out of bounds, it will always wrap around. Parameters index:int The index to set.

setIndex

back to summary

public void setIndex(int index)

Sets the internal index to the given index. If the index goes out of bounds, it will always wrap around.

Parameters

index:int: The index to set.

public Class LoopPool<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail