net.sf.javagimmicks.collections.RingCursorProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gimmicks Show documentation

Utility classes, APIs and tools for Java

There is a newer version: 0.99-alpha1

package net.sf.javagimmicks.collections;

/**
 * Extends {@link Iterable} by defining an additional method to create a
 * {@link RingCursor} which is a special kind of iterator that defines no
 * beginning or end but operations to modify or traverse the underlying data
 * structure.
 * 
 * @param 
 *           the type of elements this {@link RingCursorProvider} works on
 * @see RingCursor
 */
public interface RingCursorProvider extends Iterable
{
   /**
    * Returns a new {@link RingCursor} for the current data structure
    * 
    * @return a new {@link RingCursor}
    */
   public RingCursor cursor();
}