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

Interface Query.Controller

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.lang.AutoCloseable, java.io.Closeable, java.io.Serializable
    +
    +
    +
    All Known Implementing Classes:
    +
    Query.Timeout
    +
    +
    +
    Enclosing interface:
    +
    Query<S extends Storable>
    +
    +
    +
    +
    public static interface Query.Controller
+extends java.io.Serializable, java.io.Closeable
    +
    Controller instance can be used to abort query operations. + +

    Example:

    + Storage<UserInfo> users = ...
+ long count = users.query("name = ?").count(Query.Timeout.seconds(10));
+
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidbegin() +
      Called by query when it begins, possibly multiple times.
      +
      voidclose() +
      Always called by query when finished, even when it fails.
      +
      voidcontinueCheck() +
      Periodically called by query to determine if it should continue.
      +
      longgetTimeout() +
      Returns a non-negative value if controller imposes an absolute upper + bound on query execution time.
      +
      java.util.concurrent.TimeUnitgetTimeoutUnit() +
      Returns the unit for the timeout, if applicable.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTimeout

        +
        long getTimeout()
        +
        Returns a non-negative value if controller imposes an absolute upper + bound on query execution time.
        +
        • +
      + + + +
        +
      • +

        getTimeoutUnit

        +
        java.util.concurrent.TimeUnit getTimeoutUnit()
        +
        Returns the unit for the timeout, if applicable.
        +
        • +
      + + + +
        +
      • +

        begin

        +
        void begin()
        +
        Called by query when it begins, possibly multiple times. Implementation + is required to be idempotent and ignore multiple invocations.
        +
        • +
      + + + +
        +
      • +

        continueCheck

        +
        void continueCheck()
+                   throws FetchException
        +
        Periodically called by query to determine if it should continue.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        close

        +
        void close()
        +
        Always called by query when finished, even when it fails. Implementation + is required to be idempotent and ignore multiple invocations.
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + -- cgit v1.2.3