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

Class OrderingList<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Iterable<OrderedProperty<S>>, java.util.Collection<OrderedProperty<S>>, java.util.List<OrderedProperty<S>>
    +
    +
    +
    +
    public class OrderingList<S extends Storable>
+extends java.util.AbstractList<OrderedProperty<S>>
+implements java.io.Serializable
    +
    Produces unmodifiable lists of orderings. Instances + are immutable, canonical and cached. Calls to "equals" and "hashCode" are + fast.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class java.util.AbstractList

        +modCount
        • +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      OrderingList<S>concat(java.lang.Class<S> type, + java.lang.String property) +
      Returns a list which concatenates this one with the given property.
      +
      OrderingList<S>concat(OrderedProperty<S> property) +
      Returns a list which concatenates this one with the given property.
      +
      OrderingList<S>concat(OrderingList<S> other) +
      Returns a list which concatenates this one with the other one.
      +
      static <S extends Storable> 
      OrderingList<S>      		emptyList() +
      Returns a canonical empty instance.
      +
      booleanequals(java.lang.Object other) 
      static <S extends Storable> 
      OrderingList<S>      		get(java.lang.Class<S> type, + java.lang.String... orderings) +
      Returns a canonical instance composed of the given orderings.
      +
      static <S extends Storable> 
      OrderingList<S>      		get(java.lang.Class<S> type, + java.lang.String property) +
      Returns a canonical instance composed of the given ordering.
      +
      OrderedProperty<S>get(int index) 
      static <S extends Storable> 
      OrderingList<S>      		get(java.util.List<OrderedProperty<S>> orderings) +
      Returns a canonical instance composed of the given orderings.
      +
      static <S extends Storable> 
      OrderingList<S>      		get(OrderedProperty<S>... orderings) +
      Returns a canonical instance composed of the given orderings.
      +
      inthashCode() 
      OrderingList<S>reduce() +
      Eliminates redundant ordering properties.
      +
      OrderingList<S>replace(int index, + OrderedProperty<S> property) +
      Returns a list with the given element replaced.
      +
      OrderingList<S>reverseDirections() +
      Returns this list with all orderings in reverse.
      +
      intsize() 
      OrderingList<S>subList(int fromIndex, + int toIndex) 
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractList

        +add, add, addAll, clear, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set
        • +
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractCollection

        +addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.util.List

        +addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        emptyList

        +
        public static <S extends Storable> OrderingList<S> emptyList()
        +
        Returns a canonical empty instance.
        +
        • +
      + + + +
        +
      • +

        get

        +
        public static <S extends Storable> OrderingList<S> get(java.lang.Class<S> type,
+                                       java.lang.String property)
        +
        Returns a canonical instance composed of the given ordering.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if ordering property is not in S
        +
        • +
      + + + +
        +
      • +

        get

        +
        public static <S extends Storable> OrderingList<S> get(java.lang.Class<S> type,
+                                       java.lang.String... orderings)
        +
        Returns a canonical instance composed of the given orderings.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any ordering property is not in S
        +
        • +
      + + + + + + + +
        +
      • +

        get

        +
        public static <S extends Storable> OrderingList<S> get(java.util.List<OrderedProperty<S>> orderings)
        +
        Returns a canonical instance composed of the given orderings.
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        concat

        +
        public OrderingList<S> concat(java.lang.Class<S> type,
+                     java.lang.String property)
        +
        Returns a list which concatenates this one with the given property.
        +
        • +
      + + + +
        +
      • +

        concat

        +
        public OrderingList<S> concat(OrderedProperty<S> property)
        +
        Returns a list which concatenates this one with the given property.
        +
        • +
      + + + +
        +
      • +

        concat

        +
        public OrderingList<S> concat(OrderingList<S> other)
        +
        Returns a list which concatenates this one with the other one.
        +
        • +
      + + + +
        +
      • +

        reduce

        +
        public OrderingList<S> reduce()
        +
        Eliminates redundant ordering properties.
        +
        • +
      + + + +
        +
      • +

        reverseDirections

        +
        public OrderingList<S> reverseDirections()
        +
        Returns this list with all orderings in reverse.
        +
        • +
      + + + + + + + + + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + -- cgit v1.2.3