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

Class QueryHints

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class QueryHints
+extends java.lang.Object
+implements java.io.Serializable
    +
    An immutable map of query hints.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    QueryHint, +Serialized Form
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleancontains(QueryHint hint) +
      Returns false if hint is not provided.
      +
      static QueryHintsemptyHints() 
      booleanequals(java.lang.Object obj) 
      java.lang.Objectget(QueryHint hint) +
      Returns null if hint is not provided.
      +
      inthashCode() 
      booleanisEmpty() 
      java.lang.StringtoString() 
      QueryHintswith(QueryHint hint) +
      Returns a new QueryHints object with the given hint.
      +
      QueryHintswith(QueryHint hint, + java.lang.Object value) +
      Returns a new QueryHints object with the given hint and value.
      +
      QueryHintswithout(QueryHint hint) +
      Returns a new QueryHints object without the given hint.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        emptyHints

        +
        public static QueryHints emptyHints()
        +
        • +
      + + + +
        +
      • +

        with

        +
        public QueryHints with(QueryHint hint)
        +
        Returns a new QueryHints object with the given hint. The associated + value is the hint object itself.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if hint is null
        +
        • +
      + + + +
        +
      • +

        with

        +
        public QueryHints with(QueryHint hint,
+              java.lang.Object value)
        +
        Returns a new QueryHints object with the given hint and value.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if hint or value is null
        +
        • +
      + + + +
        +
      • +

        without

        +
        public QueryHints without(QueryHint hint)
        +
        Returns a new QueryHints object without the given hint.
        +
        • +
      + + + +
        +
      • +

        contains

        +
        public boolean contains(QueryHint hint)
        +
        Returns false if hint is not provided.
        +
        • +
      + + + +
        +
      • +

        get

        +
        public java.lang.Object get(QueryHint hint)
        +
        Returns null if hint is not provided.
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + -- cgit v1.2.3