From d479253768d296a40b4f699e1de9b03c7146a97a Mon Sep 17 00:00:00 2001 From: Jesse Morgan Date: Tue, 3 Dec 2013 14:03:28 -0800 Subject: Adding javadocs and Carbonado User Guide --- .../com/amazon/carbonado/cursor/LimitCursor.html | 366 +++++++++++++++++++++ 1 file changed, 366 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/cursor/LimitCursor.html (limited to 'apidocs/com/amazon/carbonado/cursor/LimitCursor.html') diff --git a/apidocs/com/amazon/carbonado/cursor/LimitCursor.html b/apidocs/com/amazon/carbonado/cursor/LimitCursor.html new file mode 100644 index 0000000..7663d24 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/LimitCursor.html @@ -0,0 +1,366 @@ + + + + + + +LimitCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class 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

      + + + + + + + + +
      Constructors 
      Constructor and Description
      LimitCursor(Cursor<S> source, + long limit) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      + +
        +
      • + + +

        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:
        +
        java.lang.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
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + -- cgit v1.2.3