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/EmptyCursor.html | 401 +++++++++++++++++++++ 1 file changed, 401 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/cursor/EmptyCursor.html (limited to 'apidocs/com/amazon/carbonado/cursor/EmptyCursor.html') diff --git a/apidocs/com/amazon/carbonado/cursor/EmptyCursor.html b/apidocs/com/amazon/carbonado/cursor/EmptyCursor.html new file mode 100644 index 0000000..c00cbc6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/EmptyCursor.html @@ -0,0 +1,401 @@ + + + + + + +EmptyCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class EmptyCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class EmptyCursor<S>
+extends java.lang.Object
+implements Cursor<S>
    +
    Special cursor implementation that is empty.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    SingletonCursor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Does nothing.
      +
      intcopyInto(java.util.Collection<? super S> c) +
      Performs no copy and always returns 0.
      +
      intcopyInto(java.util.Collection<? super S> c, + int limit) +
      Performs no copy and always returns 0.
      +
      booleanhasNext() +
      Always returns false.
      +
      Snext() +
      Always throws NoSuchElementException.
      +
      intskipNext(int amount) +
      Always returns 0.
      +
      static <S> Cursor<S>the() +
      Returns the empty cursor instance.
      +
      java.util.List<S>toList() +
      Always returns an empty list.
      +
      java.util.List<S>toList(int limit) +
      Always returns an empty list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        the

        +
        public static <S> Cursor<S> the()
        +
        Returns the empty cursor instance.
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +
        Does nothing.
        +
        +
        Specified by:
        +
        close in interface Cursor<S>
        +
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
        +
        Always returns false.
        +
        +
        Specified by:
        +
        hasNext in interface Cursor<S>
        +
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
        +
        Always throws NoSuchElementException.
        +
        +
        Specified by:
        +
        next in interface Cursor<S>
        +
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
        +
        Always returns 0.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        • +
      + + + +
        +
      • +

        copyInto

        +
        public int copyInto(java.util.Collection<? super S> c)
        +
        Performs no copy and always returns 0.
        +
        +
        Specified by:
        +
        copyInto in interface Cursor<S>
        +
        Returns:
        actual amount of results added
        +
        • +
      + + + +
        +
      • +

        copyInto

        +
        public int copyInto(java.util.Collection<? super S> c,
+           int limit)
        +
        Performs no copy and always returns 0.
        +
        +
        Specified by:
        +
        copyInto in interface Cursor<S>
        +
        limit - maximum amount of elements to copy
        +
        Returns:
        actual amount of results added
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public java.util.List<S> toList()
        +
        Always returns an empty list.
        +
        +
        Specified by:
        +
        toList in interface Cursor<S>
        +
        Returns:
        a new modifiable list
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public java.util.List<S> toList(int limit)
        +
        Always returns an empty list.
        +
        +
        Specified by:
        +
        toList in interface Cursor<S>
        +
        Parameters:
        limit - maximum amount of elements to copy
        +
        Returns:
        a new modifiable list
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + -- cgit v1.2.3