asdoc/mx/utils/ArrayUtil.js.json

{ "type": "class",
  "qname": "mx.utils.ArrayUtil",
  "baseClassname": ""
  ,
    "description": "The ArrayUtil utility class is an all-static class with methods for working with arrays within Flex. You do not create instances of ArrayUtil; instead you call static methods such as the <code>ArrayUtil.toArray()</code> method.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["Flex 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "toArray",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Ensures that an Object can be used as an Array.  <p>If the Object is already an Array, it returns the object. If the object is not an Array, it returns an Array in which the only element is the Object. If the Object implements IList it returns the IList's array. As a special case, if the Object is null, it returns an empty Array.</p>   the original Array is returned. If the original Object is an IList then it's array is returned. Otherwise, a new Array whose only element is the Object is returned or an empty Array if the Object was null.",
        "tags": [
        {  "tagName": "param",
               "values": ["obj Object that you want to ensure is an array."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "return",
               "values": ["An Array. If the original Object is already an Array,"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Array",
          "params": [{ "name": "obj", "type": "Object"}]}
      ,
      { "type": "method",
        "qname": "getItemIndex",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Returns the index of the item in the Array.",
        "tags": [
        {  "tagName": "param",
               "values": ["item The item to find in the Array.", "source The Array to search for the item."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "return",
               "values": ["The index of the item, and -1 if the item is not in the list."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "int",
          "params": [{ "name": "item", "type": "Object"},
        { "name": "source", "type": "Array"}]}
      ,
      { "type": "method",
        "qname": "arraysMatch",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Checks if the Array instances contain the same values against the same indexes, even if in different orders.  values of the two Arrays using the strict equality operator (===) or not (==). (determined using the strict equality operator) associated with the same indexes.",
        "tags": [
        {  "tagName": "param",
               "values": ["a The first Array instance.", "b The second Array instance.", "strictEqualityCheck true if we should compare the"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "return",
               "values": ["true if the two Arrays contain the same values"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "a", "type": "Array"},
        { "name": "b", "type": "Array"},
        { "name": "strictEqualityCheck", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "arrayValuesMatch",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Checks if the Array instances contain the same values, even if in different orders.  values of the two Arrays using the strict equality operator (===) or not (==).",
        "tags": [
        {  "tagName": "param",
               "values": ["a The first Array instance.", "b The second Array instance.", "strictEqualityCheck true if we should compare the"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "return",
               "values": ["true if the two Arrays contain the same values."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "a", "type": "Array"},
        { "name": "b", "type": "Array"},
        { "name": "strictEqualityCheck", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "getArrayValues",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Used to obtain the values in an Array, whether indexed or associative.",
        "tags": [
        {  "tagName": "param",
               "values": ["value The Array instance."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "return",
               "values": ["an indexed Array with the values found in <code>value</code>."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Array",
          "params": [{ "name": "value", "type": "Array"}]}
      ]
  }