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/info/Direction.html | 388 +++++++++++++++++++++++ 1 file changed, 388 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/info/Direction.html (limited to 'apidocs/com/amazon/carbonado/info/Direction.html') diff --git a/apidocs/com/amazon/carbonado/info/Direction.html b/apidocs/com/amazon/carbonado/info/Direction.html new file mode 100644 index 0000000..b1e7db0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/Direction.html @@ -0,0 +1,388 @@ + + + + + + +Direction (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.info
+

Enum Direction

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<Direction>
    +
    +
    +
    +
    public enum Direction
+extends java.lang.Enum<Direction>
    +
    Describes a property sorting direction.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static DirectionfromCharacter(char c) +
      Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything + else.
      +
      Directionreverse() +
      Returns the reverse direction of this.
      +
      chartoCharacter() +
      Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.
      +
      static DirectionvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static Direction[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        ASCENDING

        +
        public static final Direction ASCENDING
        +
        • +
      + + + +
        +
      • +

        DESCENDING

        +
        public static final Direction DESCENDING
        +
        • +
      + + + +
        +
      • +

        UNSPECIFIED

        +
        public static final Direction UNSPECIFIED
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static Direction[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (Direction c : Direction.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in +the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static Direction valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public Direction reverse()
        +
        Returns the reverse direction of this.
        +
        • +
      + + + +
        +
      • +

        toCharacter

        +
        public char toCharacter()
        +
        Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.
        +
        • +
      + + + +
        +
      • +

        fromCharacter

        +
        public static Direction fromCharacter(char c)
        +
        Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything + else.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + -- cgit v1.2.3