com.amazon.carbonado.cursor
Class LimitCursor<S>

java.lang.Object
  com.amazon.carbonado.cursor.AbstractCursor<S>
      com.amazon.carbonado.cursor.LimitCursor<S>

All Implemented Interfaces:

Cursor<S>

public class LimitCursor<S>
extends AbstractCursor<S>

Wraps another cursor to limit the amount of elements.

Since:

1.2

Author:

Brian S O'Neill

See Also:

SkipCursor

Constructor Summary

LimitCursor(Cursor<S> source, long limit)

Method Summary

void	close() Call close to release any resources being held by this cursor.
boolean	hasNext() Returns true if this cursor has more elements.
S	next() Returns the next element from this cursor.
int	skipNext(int amount) Skips forward by the specified amount of elements, returning the actual amount skipped.

Methods inherited from class com.amazon.carbonado.cursor.AbstractCursor

copyInto, copyInto, toList, toList

Methods inherited from class java.lang.Object

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

Constructor Detail

LimitCursor

public LimitCursor(Cursor<S> source,
                   long limit)

Parameters:

limit - maximum amount of elements

Throws:

IllegalArgumentException - if source is null or limit is negative

Method Detail

hasNext

public boolean hasNext()
                throws FetchException

Description copied from interface: Cursor

Returns true if this cursor has more elements. In other words, returns true if next would return an element rather than throwing an exception.

Throws:

FetchException - if storage layer throws an exception

next

public S next()
       throws FetchException

Description copied from interface: Cursor

Returns the next element from this cursor. This method may be called repeatedly to iterate through the results.

Throws:

FetchException - if storage layer throws an exception

skipNext

public int skipNext(int amount)
             throws FetchException

Description copied from interface: Cursor

Skips forward by the specified amount of elements, returning the actual amount skipped. The actual amount is less than the requested amount only if the end of the results was reached.

Specified by:

skipNext in interface Cursor<S>

Overrides:

skipNext in class AbstractCursor<S>

Parameters:

amount - maximum amount of elements to skip

Returns:

actual amount skipped

Throws:

FetchException - if storage layer throws an exception

close

public void close()
           throws FetchException

Description copied from interface: Cursor

Call close to release any resources being held by this cursor. Further operations on this cursor will behave as if there are no results.

Throws:

FetchException