Packageorg.iotashan.classes
Classpublic class StringList

List utility methods. Note that unlike ColdFusion, ActionScript (and therefore these methods') indexes start at 0.



Public Methods
 MethodDefined by
  
Constructor method
StringList
  
arrayToList(array:Array, delimiters:String = ","):String
[static] Converts an array of strings to a list.
StringList
  
listAppend(list:String, value:String, delimiters:String = ","):String
[static] Appends a value to the end of the list.
StringList
  
listChangeDelims(list:String, newDelimiter:String, delimiters:String = ","):String
[static] Changes delimiters of the list
StringList
  
listContains(list:String, substr:String, delimiters:String = ","):String
[static] Returns a list of the indexes where the substring is found.
StringList
  
listContainsNoCase(list:String, substr:String, delimiters:String = ","):String
[static] Returns a list of the indexes where the case-insenitive substring is found.
StringList
  
listDeleteAt(list:String, index:Number, delimiters:String = ","):String
[static] Deletes a value at the specified index.
StringList
  
listDeleteEmptyElements(list:String, delimiters:String = ","):String
[static] Returns a list with empty elements removed.
StringList
  
listDistinct(list:String, delimiters:String = ","):String
[static] Returns all unique elements in a list.
StringList
  
listFillEmptyElements(list:String, value:String, delimiters:String = ","):String
[static] Returns a list with empty elements replaced with a value.
StringList
  
listFind(list:String, value:String, delimiters:String = ","):Number
[static] Returns the index of the case sensitive value in the list.
StringList
  
listFindNoCase(list:String, value:String, delimiters:String = ","):Number
[static] Returns the index of the case insensitive value in the list.
StringList
  
listFirst(list:String, delimiters:String = ","):String
[static] Returns the first value in the list.
StringList
  
listGetAt(list:String, index:Number, delimiters:String = ","):String
[static] Returns the value at the specified index.
StringList
  
listInsertAt(list:String, index:Number, value:String, delimiters:String = ","):String
[static] Inserts a value at the specified index.
StringList
  
listLast(list:String, delimiters:String = ","):String
[static] Returns the last value of the list.
StringList
  
listLen(list:String, delimiters:String = ","):Number
[static] Returns the number of items in the list.
StringList
  
listMid(list:String, start:Number, elements:Number, delimiters:String = ","):String
[static] Returns a list of elements from the index specified through the number of elements specified.
StringList
  
listPrepend(list:String, value:String, delimiters:String = ","):String
[static] Adds a value to the beginning of the list.
StringList
  
listQualify(list:String, qualifier:String, delimiters:String = ",", elements:String = "all"):String
[static] Adds a qualifiying string to either all elements, or non-numeric elements.
StringList
  
listRest(list:String, delimiters:String = ","):String
[static] Gets a list, without its first element.
StringList
  
listReverse(list:String, delimiters:String = ","):String
[static] Returns a list of elements in reverse order.
StringList
  
listSetAt(list:String, index:Number, value:String, delimiters:String = ","):String
[static] Sets a value at the specified index.
StringList
  
listSort(list:String, sortType:String, sortOrder:String, delimiters:String = ","):String
[static] Sorts list elements according to a sort type and sort order.
StringList
  
listToArray(list:String, delimiters:String = ","):Array
[static] Converts the specified list to an array.
StringList
  
listValueCount(list:String, value:String, delimiters:String = ","):Number
[static] Returns the number of times a value is found in the list.
StringList
  
listValueCountNoCase(list:String, value:String, delimiters:String = ","):Number
[static] Returns the number of times a case-insenstive value is found in the list.
StringList
Public Constants
 ConstantDefined by
  ALL_ELEMENTS : String = "all"
[static] The StringList.STRINGS_ONLY constant defines the value of the elements property of the listQualify method.
StringList
  ASCENDING : String = "asc"
[static] The StringList.ASCENDING constant defines the value of the sortOrder property of the listSort method.
StringList
  DECENDING : String = "dsc"
[static] The StringList.DECENDING constant defines the value of the sortOrder property of the listSort method.
StringList
  NUMERIC : String = "numeric"
[static] The StringList.NUMERIC constant defines the value of the sortType property of the listSort method.
StringList
  STRINGS_ONLY : String = "char"
[static] The StringList.STRINGS_ONLY constant defines the value of the elements property of the listQualify method.
StringList
  TEXT : String = "text"
[static] The StringList.TEXT constant defines the value of the sortType property of the listSort method.
StringList
  TEXT_NO_CASE : String = "textnocase"
[static] The StringList.TEXT_NO_CASE constant defines the value of the sortType property of the listSort method.
StringList
Constructor detail
StringList()constructor
public function StringList()

Constructor method

Method detail
arrayToList()method
public static function arrayToList(array:Array, delimiters:String = ","):String

Converts an array of strings to a list.

Parameters
array:Array
 
delimiters:String (default = ",")

Returns
String

See also


Example
StringList.arrayToList(["one","two","three"]); // returns "one,two,three"

listAppend()method 
public static function listAppend(list:String, value:String, delimiters:String = ","):String

Appends a value to the end of the list.

Parameters
list:String
 
value:String
 
delimiters:String (default = ",")

Returns
String

See also


Example
StringList.listAppend("one,two,three","go!"); // returns "one,two,three,go!"

listChangeDelims()method 
public static function listChangeDelims(list:String, newDelimiter:String, delimiters:String = ","):String

Changes delimiters of the list

Parameters
list:String
 
newDelimiter:String
 
delimiters:String (default = ",")

Returns
String

Example
StringList.listChangeDelims("one,two,three","|"); // returns "one|two|three"

listContains()method 
public static function listContains(list:String, substr:String, delimiters:String = ","):String

Returns a list of the indexes where the substring is found. If there are no matches, returns -1.

Parameters
list:String
 
substr:String
 
delimiters:String (default = ",")

Returns
String

See also


Example
StringList.listContains("one,two,three,TWO,two,Two","two"); // returns "1,4"

listContainsNoCase()method 
public static function listContainsNoCase(list:String, substr:String, delimiters:String = ","):String

Returns a list of the indexes where the case-insenitive substring is found. If there are no matches, returns -1.

Parameters
list:String
 
substr:String
 
delimiters:String (default = ",")

Returns
String

See also


Example
StringList.listContains("one,two,three,TWO,two,Two","two"); // returns "1,3,4,5"

listDeleteAt()method 
public static function listDeleteAt(list:String, index:Number, delimiters:String = ","):String

Deletes a value at the specified index.

Parameters
list:String
 
index:Number
 
delimiters:String (default = ",")

Returns
String

See also


Example
StringList.listDeleteAt("one,two,three",1); // returns "one,three"

listDeleteEmptyElements()method 
public static function listDeleteEmptyElements(list:String, delimiters:String = ","):String

Returns a list with empty elements removed.

Parameters
list:String
 
delimiters:String (default = ",")

Returns
String

See also


Example
StringList.listDeleteEmptyElements("one,two,,four,,,seven"); // returns "one,two,four,seven"

listDistinct()method 
public static function listDistinct(list:String, delimiters:String = ","):String

Returns all unique elements in a list.

Parameters
list:String
 
delimiters:String (default = ",")

Returns
String

Example
StringList.listDistinct("one,two,three,TWO,two,Two"); // returns "one,two,three,TWO,Two"

listFillEmptyElements()method 
public static function listFillEmptyElements(list:String, value:String, delimiters:String = ","):String

Returns a list with empty elements replaced with a value.

Parameters
list:String
 
value:String
 
delimiters:String (default = ",")

Returns
String

See also


Example
StringList.listFillEmptyElements("one,two,,four,,,seven","NULL"); // returns "one,two,NULL,four,NULL,NULL,seven"

listFind()method 
public static function listFind(list:String, value:String, delimiters:String = ","):Number

Returns the index of the case sensitive value in the list. Returns -1 if not found.

Parameters
list:String
 
value:String
 
delimiters:String (default = ",")

Returns
Number

See also


Example
StringList.listFind("one,two,three","two"); // returns 1

listFindNoCase()method 
public static function listFindNoCase(list:String, value:String, delimiters:String = ","):Number

Returns the index of the case insensitive value in the list. Returns -1 if not found.

Parameters
list:String
 
value:String
 
delimiters:String (default = ",")

Returns
Number

See also


Example
StringList.listFind("one,two,three","TwO"); // returns 1

listFirst()method 
public static function listFirst(list:String, delimiters:String = ","):String

Returns the first value in the list.

Parameters
list:String
 
delimiters:String (default = ",")

Returns
String

See also


Example
StringList.listFirst("one,two,three"); // returns "one"

listGetAt()method 
public static function listGetAt(list:String, index:Number, delimiters:String = ","):String

Returns the value at the specified index.

Parameters
list:String
 
index:Number
 
delimiters:String (default = ",")

Returns
String

Example
StringList.listGetAt("one,two,three",2); // returns "three"

listInsertAt()method 
public static function listInsertAt(list:String, index:Number, value:String, delimiters:String = ","):String

Inserts a value at the specified index.

Parameters
list:String
 
index:Number
 
value:String
 
delimiters:String (default = ",")

Returns
String

Example
StringList.listInsertAt("one,two,three","two and a half",2); // returns "one,two,two and a half,three"

listDeleteAt()

listLast()method 
public static function listLast(list:String, delimiters:String = ","):String

Returns the last value of the list.

Parameters
list:String
 
delimiters:String (default = ",")

Returns
String

See also


Example
StringList.listLast("one,two,three"); // returns "three"

listLen()method 
public static function listLen(list:String, delimiters:String = ","):Number

Returns the number of items in the list.

Parameters
list:String
 
delimiters:String (default = ",")

Returns
Number

Example
StringList.listLen("one,two,three"); // returns 3

listMid()method 
public static function listMid(list:String, start:Number, elements:Number, delimiters:String = ","):String

Returns a list of elements from the index specified through the number of elements specified.

Parameters
list:String
 
start:Number
 
elements:Number
 
delimiters:String (default = ",")

Returns
String

See also


Example
StringList.listMid("one,two,three,four",1,2); // returns "two,three"

listPrepend()method 
public static function listPrepend(list:String, value:String, delimiters:String = ","):String

Adds a value to the beginning of the list.

Parameters
list:String
 
value:String
 
delimiters:String (default = ",")

Returns
String

See also


Example
StringList.listPrepend("one,two,three","ready"); // returns "ready,one,two,three"

listQualify()method 
public static function listQualify(list:String, qualifier:String, delimiters:String = ",", elements:String = "all"):String

Adds a qualifiying string to either all elements, or non-numeric elements. Useful for putting quotes around strings, like if you are building a CSV file.

Parameters
list:String — Accepts the constants StringList.STRINGS_ONLY or StringList.ALL_ELEMENTS
 
qualifier:String
 
delimiters:String (default = ",")
 
elements:String (default = "all")

Returns
String

See also


Example
StringList.listQualify("one,2,three,four","'",StringList.STRINGS_ONLY); // returns "'one',2,'three','four'"

listRest()method 
public static function listRest(list:String, delimiters:String = ","):String

Gets a list, without its first element.

Parameters
list:String
 
delimiters:String (default = ",")

Returns
String

See also


Example
StringList.listRest("one,two,three"); // returns "two,three"

listReverse()method 
public static function listReverse(list:String, delimiters:String = ","):String

Returns a list of elements in reverse order.

Parameters
list:String
 
delimiters:String (default = ",")

Returns
String

Example
StringList.listReverse("one,two,three"); // returns "three,two,one"

listSetAt()method 
public static function listSetAt(list:String, index:Number, value:String, delimiters:String = ","):String

Sets a value at the specified index.

Parameters
list:String
 
index:Number
 
value:String
 
delimiters:String (default = ",")

Returns
String

Example
StringList.listSetAt("one,two,three","2",1); // returns "one,2,three"

listSort()method 
public static function listSort(list:String, sortType:String, sortOrder:String, delimiters:String = ","):String

Sorts list elements according to a sort type and sort order.

Parameters
list:String
 
sortType:String
 
sortOrder:String
 
delimiters:String (default = ",")

Returns
String

See also


Example
StringList.listSort("beta,alpha,delta,gamma"); // returns "alpha,beta,delta,gamma"

listToArray()method 
public static function listToArray(list:String, delimiters:String = ","):Array

Converts the specified list to an array.

Parameters
list:String
 
delimiters:String (default = ",")

Returns
Array

See also


Example
StringList.listToArray("one,two,three"); // returns array ["one","two","three"]

listValueCount()method 
public static function listValueCount(list:String, value:String, delimiters:String = ","):Number

Returns the number of times a value is found in the list.

Parameters
list:String
 
value:String
 
delimiters:String (default = ",")

Returns
Number

See also


Example
StringList.listValueCount("one,two,three,TWO,two,Two","two"); // returns 2

listValueCountNoCase()method 
public static function listValueCountNoCase(list:String, value:String, delimiters:String = ","):Number

Returns the number of times a case-insenstive value is found in the list.

Parameters
list:String
 
value:String
 
delimiters:String (default = ",")

Returns
Number

See also


Example
StringList.listValueCountNoCase("one,two,three,TWO,two,Two","two"); // returns 4

Constant detail
ALL_ELEMENTSconstant
public static const ALL_ELEMENTS:String = "all"

The StringList.STRINGS_ONLY constant defines the value of the elements property of the listQualify method. This will add the qualifier to all elements in the list.

See also

ASCENDINGconstant 
public static const ASCENDING:String = "asc"

The StringList.ASCENDING constant defines the value of the sortOrder property of the listSort method. Ascending sort order.
- aabzABZ or aAaBbBzzZ, depending on value of sort_type, for letters
- from smaller to larger, for numbers

See also

DECENDINGconstant 
public static const DECENDING:String = "dsc"

The StringList.DECENDING constant defines the value of the sortOrder property of the listSort method. Decending sort order.
- ZBAzbaa or ZzzBbBaAa, depending on value of sort_type, for letters
- from larger to smaller, for numbers

See also

NUMERICconstant 
public static const NUMERIC:String = "numeric"

The StringList.NUMERIC constant defines the value of the sortType property of the listSort method. Sorts numbers.

See also

STRINGS_ONLYconstant 
public static const STRINGS_ONLY:String = "char"

The StringList.STRINGS_ONLY constant defines the value of the elements property of the listQualify method. This will only add the qualifer to elements that are strings.

See also

TEXTconstant 
public static const TEXT:String = "text"

The StringList.TEXT constant defines the value of the sortType property of the listSort method. Sorts text alphabetically, taking case into account (also known as case sensitive). All letters of one case precede the first letter of the other case:
- abzABZ, if sortOrder = StringList.ASCENDING (ascending sort)
- ZBAzbaa, if sortOrder = "desc" (descending sort)

See also

TEXT_NO_CASEconstant 
public static const TEXT_NO_CASE:String = "textnocase"

The StringList.TEXT_NO_CASE constant defines the value of the sortType property of the listSort method. Sorts text alphabetically, without regard to case (also known as case-insensitive). A letter in varying cases precedes the next letter:
- aAaBbBzzZ, in an ascending sort; preserves original intra-letter order
- ZzBbBaAa, in a descending sort; reverses original intra-letter order

See also