asdoc/org/apache/royale/collections/CompareUtils.js.json

{ "type": "class",
  "qname": "org.apache.royale.collections.CompareUtils",
  "baseClassname": ""
  ,
  "members": [
  { "type": "method",
        "qname": "sort",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Sort an <code>IArrayListView</code> collection",
        "tags": [
        {  "tagName": "param",
               "values": ["collection     The Collection to sort", "sortBy         The name of the field to sort", "orderDesc        True ASC , false DESC", "numericSort    If the sorting should be numeric or alphanumeric"]},
            {  "tagName": "return",
               "values": ["the collection"]}  ],
          "return": "org.apache.royale.collections.IArrayListView",
          "params": [{ "name": "collection", "type": "org.apache.royale.collections.IArrayListView"},
        { "name": "sortBy", "type": "String"},
        { "name": "orderDesc", "type": "Boolean"},
        { "name": "numericSort", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "numericCompare",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Compares two numeric values.    1 if only <code>a</code> is a NaN. -1 if only <code>b</code> is a NaN. -1 if <code>a</code> is less than <code>b</code>. 1 if <code>a</code> is greater than <code>b</code>.",
        "tags": [
        {  "tagName": "param",
               "values": ["a First number.", "b Second number."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "return",
               "values": ["0 is both numbers are NaN."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "int",
          "params": [{ "name": "a", "type": "Number"},
        { "name": "b", "type": "Number"}]}
      ,
      { "type": "method",
        "qname": "stringCompare",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Compares two String values.    <code>true</code>, or not, <code>false</code>.  1 if only <code>a</code> is null. -1 if only <code>b</code> is null. -1 if <code>a</code> precedes <code>b</code>. 1 if <code>b</code> precedes <code>a</code>.",
        "tags": [
        {  "tagName": "param",
               "values": ["a First String value.", "b Second String value.", "caseInsensitive Specifies to perform a case insensitive compare,"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "return",
               "values": ["0 is both Strings are null."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "int",
          "params": [{ "name": "a", "type": "String"},
        { "name": "b", "type": "String"},
        { "name": "caseInsensitive", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "dateCompare",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Compares the two Date objects and returns an integer value indicating if the first Date object is before, equal to, or after the second item.    (or both are <code>null</code>); -1 if <code>a</code> is before <code>b</code> (or <code>b</code> is <code>null</code>); 1 if <code>a</code> is after <code>b</code> (or <code>a</code> is <code>null</code>); 0 is both dates getTime's are NaN; 1 if only <code>a</code> getTime is a NaN; -1 if only <code>b</code> getTime is a NaN.",
        "tags": [
        {  "tagName": "param",
               "values": ["a Date object.", "b Date object."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "return",
               "values": ["0 if <code>a</code> and <code>b</code> are equal"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "int",
          "params": [{ "name": "a", "type": "Date"},
        { "name": "b", "type": "Date"}]}
      ]
  }