me.lucko.helper.utils

Class Cycle<E>

java.lang.Object

me.lucko.helper.utils.Cycle<E>

All Implemented Interfaces:

Cycle<E>

Deprecated.

@Deprecated
public final class Cycle<E>
extends Object
implements Cycle<E>

Constructor Summary

Constructors

Constructor and Description
Cycle(List<E> objects) Deprecated.

Method Summary

Modifier and Type	Method and Description
E	back() Deprecated.
Cycle<E>	copy() Deprecated. Creates a copy of this cycle.
E	current() Deprecated. Gets the current element
int	cursor() Deprecated. Gets the current position of the cursor, as as index relating to a position in the backing list.
List<E>	getBacking() Deprecated. Gets the list currently backing this cycle
int	getIndex() Deprecated.
E	next() Deprecated. Advances the cursor, and returns the next element.
int	nextPosition() Deprecated. Returns the index of the next position in the cycle.
E	peekNext() Deprecated. Returns the next element without advancing the cursor.
E	peekPrevious() Deprecated. Returns the previous element without retreating the cursor.
E	previous() Deprecated. Retreats the counter, and returns the previous element.
int	previousPosition() Deprecated. Returns the index of the previous position in the cycle.
void	setCursor(int index) Deprecated. Sets the cursor to a given index

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface me.lucko.helper.bucket.Cycle

of

Constructor Detail

Cycle

public Cycle(@Nonnull
             List<E> objects)

Deprecated.

Method Detail

cursor

public int cursor()

Deprecated.

Description copied from interface: Cycle

Gets the current position of the cursor, as as index relating to a position in the backing list.

Specified by:

cursor in interface Cycle<E>

Returns:

the cursor position

setCursor

public void setCursor(int index)

Deprecated.

Description copied from interface: Cycle

Sets the cursor to a given index

Specified by:

setCursor in interface Cycle<E>

Parameters:

index - the index to set the cursor to

current

@Nonnull
public E current()

Deprecated.

Description copied from interface: Cycle

Gets the current element

Specified by:

current in interface Cycle<E>

Returns:

the current element

next

@Nonnull
public E next()

Deprecated.

Description copied from interface: Cycle

Advances the cursor, and returns the next element.

Specified by:

next in interface Cycle<E>

Returns:

the next element

previous

@Nonnull
public E previous()

Deprecated.

Description copied from interface: Cycle

Retreats the counter, and returns the previous element.

Specified by:

previous in interface Cycle<E>

Returns:

the previous element

nextPosition

public int nextPosition()

Deprecated.

Description copied from interface: Cycle

Returns the index of the next position in the cycle.

Specified by:

nextPosition in interface Cycle<E>

Returns:

the next position

previousPosition

public int previousPosition()

Deprecated.

Description copied from interface: Cycle

Returns the index of the previous position in the cycle.

Specified by:

previousPosition in interface Cycle<E>

Returns:

the previous position

peekNext

@Nonnull
public E peekNext()

Deprecated.

Description copied from interface: Cycle

Returns the next element without advancing the cursor.

Specified by:

peekNext in interface Cycle<E>

Returns:

the next element

peekPrevious

@Nonnull
public E peekPrevious()

Deprecated.

Description copied from interface: Cycle

Returns the previous element without retreating the cursor.

Specified by:

peekPrevious in interface Cycle<E>

Returns:

the previous element

getBacking

@Nonnull
public List<E> getBacking()

Deprecated.

Description copied from interface: Cycle

Gets the list currently backing this cycle

The returned list is immutable.

Specified by:

getBacking in interface Cycle<E>

Returns:

the backing list

getIndex

@Deprecated
public int getIndex()

Deprecated.

back

@Deprecated
public E back()

Deprecated.

copy

public Cycle<E> copy()

Deprecated.

Description copied from interface: Cycle

Creates a copy of this cycle.

The returned cycle will contain the same elements as this cycle, but its cursor will be reset to zero.

Specified by:

copy in interface Cycle<E>

Returns:

a copy of this cycle