Class com.sekati.utils.ArrayUtils

Description

Static class wrapping various Array utilities.

Method Index

asort(), clone(), compare(), insert(), locatePropVal(), locatePropValIndex(), matchValues(), max(), maxVal(), merge(), min(), minVal(), remove(), removeDuplicate(), search(), shuffle(), sliceByPropVal(), swap()

Method Detail

insert

static public function insert(a:Array, objElement:Object, nIndex:Number):Array

insert an element into array at a specific index

Parameters

a(Array)
objElement(Object)
nIndex(Number)

Return

Array

remove

static public function remove(a:Array, objElement:Object):Array

remove all instances of an element from an array

Parameters

a(Array)
objElement(Object)

Return

Array

search

static public function search(a:Array, objElement:Object):Number

search an array for a given element and return its index or null

Parameters

a(Array)
objElement(Object)

Return

Number

shuffle

static public function shuffle(a:Array):Void

shuffle array items

Parameters

a(Array)

Return

Void

clone

static public function clone(a:Array):Array

return a clone of the array

Parameters

a(Array)

Return

Array

merge

static public function merge(aA:Array, aB:Array):Array

merge two arrays into one

Parameters

aA(Array)
aB(Array)

Return

Array

swap

static public function swap(a:Array, nA:Number, nB:Number):Array

Swap two elements positions in an array

Parameters

a(Array)
nA(Number) element A's index
nB(Number) element B's index

Return

Array

Throws

Erroron invalid array index

asort

static public function asort(a:Array):Array

Return alphabetically sorted array.

Parameters

a(Array)

Return

Array

removeDuplicate

static public function removeDuplicate(a:Array):Array

return array with duplicate entries removed

Parameters

a(Array)

Return

Array

matchValues

static public function matchValues(aA:Array, aB:Array):Boolean

compare two arrays for a matching value

Parameters

aA(Array)
aB(Array)

Return

Boolean

compare

static public function compare(aA:Array, aB:Array):Boolean

compare two arrays to see if they are identical

Parameters

aA(Array)
aB(Array)

Return

Boolean

locatePropVal

static public function locatePropVal(objArr:Array, prop:String, val:Object, isCaseInsensitive:Boolean):Object

Search for a specific value of a property in an array of objects

Parameters

objArr(Array) array of objects
prop(String) property to search
val(Object) value to locate
isCaseInsensitive(Boolean) - define whether prop and val should be case-insensitive [default: false]

Return

Object - that matches property value

locatePropValIndex

static public function locatePropValIndex(a:Array, prop:String, val:Object):Number

Search for a unique value property match and return its index in the array.

Parameters

a(Array) array of objects
prop(String) property to search
val(Object) value to locate

Return

Number - index of hit

sliceByPropVal

static public function sliceByPropVal(objArr:Array, prop:String, val:Object, isCaseInsensitive:Boolean):Array

Return a new array sliced from original array based on a value property match

Parameters

objArr(Array) array of objects
prop(String) property to search
val(Object) value to locate
isCaseInsensitive(Boolean) - define whether prop and val should be case-insensitive [default: false]

Return

Array - array of objects that matches property value

min

static public function min(a:Array):Number

Return the index of the minimum value in a numeric array

Parameters

a(Array)

Return

Number - minimum value

max

static public function max(a:Array):Number

Return the index of the maximum value in a numeric array

Parameters

a(Array)

Return

Number - maximum value

minVal

static public function minVal(a:Array):Number

Return the minimum value in a numeric array

Parameters

a(Array)

Return

Number - minimum value (0 is returned with 0 length array)

maxVal

static public function maxVal(a:Array):Number

Return the maximum value in a numeric array

Parameters

a(Array)

Return

Number - maximum value