com.adobe.fiber.runtime.lib

# StringFunc - AS3 ADEP Data Services

Package | com.adobe.fiber.runtime.lib
Class | public class StringFunc
Inheritance | StringFunc Object

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

The StringFunc class defines the implementations of the expression runtime functions for String functions in the Adobe application modeling language.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | charAt(s:String, pos:int):String [static] Returns the character at the indicated position. | StringFunc
|  | chr(c:int):String [static] Returns the character with the provided code. | StringFunc
|  | compare(s1:String, s2:String):int [static] Compares two strings lexicographically. | StringFunc
|  | compareNoCase(s1:String, s2:String):int [static] Compare two strings lexicographically, ignoring case. | StringFunc
|  | endsWith(sub:String, str:String):Boolean [static] Tests if this string ends with the specified suffix. | StringFunc
|  | find(sub:String, str:String):int [static] Returns the index of the substring within the string. | StringFunc
|  | findLast(sub:String, str:String):int [static] Returns the index within this string of the rightmost occurrence of the specified substring. | StringFunc
|  | findLastNoCase(sub:String, str:String):int [static] Returns the index within this string of the rightmost occurrence of the specified substring, ignoring case. | StringFunc
|  | findNoCase(sub:String, str:String):int [static] Returns the index of the substring within the string, ignoring case. | StringFunc
|  | findOneOf(cset:String, str:String):int [static] Finds the first occurrence of any one of a set of characters in a string. | StringFunc
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | insert(sub:String, str:String, pos:int):String [static] Inserts a substring in a string after a specified character position. | StringFunc
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | left(str:String, count:int):String [static] Gets the leftmost characters from a string. | StringFunc
|  | leftTrim(input:String):String [static] Removes whitespace from the front of the specified string. | StringFunc
|  | len(s:String):int [static] Returns the length of a string. | StringFunc
|  | lower(str:String):String [static] Converts a string to lowercase. | StringFunc
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | removeChars(str:String, start:int, count:int):String [static] Returns a copy of the string, with count characters removed from the specified start position. | StringFunc
|  | repeatString(str:String, count:int):String [static] Creates a string that contains a specified number of repetitions of the specified string. | StringFunc
|  | replace(input:String, search:String, replace:String):String [static] Replaces first occurrence of search in the input string with replace. | StringFunc
|  | replaceAll(input:String, search:String, replace:String):String [static] Replaces all occurrences of search in the input string with replace. | StringFunc
|  | replaceAllNoCase(input:String, search:String, replace:String):String [static] Replaces all occurrences of search in the input string with replace. | StringFunc
|  | replaceNoCase(input:String, search:String, replace:String):String [static] Replaces first occurrence of search in the input string with replace. | StringFunc
|  | reverse(s:String):String [static] Reverse the characters in a string. | StringFunc
|  | right(str:String, count:int):String [static] Returns the specified number of characters from the end (or right side) of the specified string. | StringFunc
|  | rightTrim(input:String):String [static] Removes trailing white space from a string. | StringFunc
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | spanExcluding(str:String, cset:String):String [static] Gets characters from a string, from the beginning to a character that is in a specified set of characters. | StringFunc
|  | spanIncluding(str:String, cset:String):String [static] Gets characters from a string, from the beginning to a character that is not in a specified set of characters. | StringFunc
|  | startsWith(prefix:String, input:String):Boolean [static] Returns true if string starts with a specified prefix. | StringFunc
|  | substring(str:String, s:int, c:int):String [static] Extracts a substring from a string, beginning at s (start), of length c (count). | StringFunc
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | trim(s:String):String [static] Removes whitespace from the start and end of a string. | StringFunc
|  | upper(s:String):String [static] Converts a string to uppercase. | StringFunc
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Method Detail

### charAt

()
method

`public static function charAt(s:String, pos:int):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns the character at the indicated position.

Parameters

| `s:String` — String
| `pos:int` — Position - 0 is the first character in the string

Returns

| `String` — Character

### chr

()
method

`public static function chr(c:int):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns the character with the provided code.

Parameters

| `c:int` — Code

Returns

| `String` — Character

### compare

()
method

`public static function compare(s1:String, s2:String):int`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Compares two strings lexicographically.

Parameters

| `s1:String` — String
| `s2:String` — String

Returns

| `int` — Value 0 if the argument string is equal to this string; -1 if this string is lexicographically less than the string argument; +1 if this string is lexicographically greater than the string argument.

### compareNoCase

()
method

`public static function compareNoCase(s1:String, s2:String):int`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Compare two strings lexicographically, ignoring case.

Parameters

| `s1:String` — String
| `s2:String` — String

Returns

| `int` — 0 if the argument string is equal to this string; -1 if this string is lexicographically less than the string argument; +1 if this string is lexicographically greater than the string argument.

### endsWith

()
method

`public static function endsWith(sub:String, str:String):Boolean`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Tests if this string ends with the specified suffix.

Parameters

| `sub:String` — Suffix to test
| `str:String` — String

Returns

| `Boolean` — true if the string ends with the suffix

### find

()
method

`public static function find(sub:String, str:String):int`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns the index of the substring within the string.

Parameters

| `sub:String` — Substring to find
| `str:String` — String

Returns

| `int` — Index of the substring, or -1 if not found

### findLast

()
method

`public static function findLast(sub:String, str:String):int`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns the index within this string of the rightmost occurrence of the specified substring.

Parameters

| `sub:String` — Substring to look for
| `str:String` — String

Returns

| `int` — Index of the first character of the last substring is returned or -1 if not found.

### findLastNoCase

()
method

`public static function findLastNoCase(sub:String, str:String):int`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns the index within this string of the rightmost occurrence of the specified substring, ignoring case.

Parameters

| `sub:String` — Substring to look for
| `str:String` — String

Returns

| `int` — Index of the first character of the last substring is returned or -1 if not found.

### findNoCase

()
method

`public static function findNoCase(sub:String, str:String):int`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns the index of the substring within the string, ignoring case.

Parameters

| `sub:String` — Substring to find
| `str:String` — String

Returns

| `int` — Index of the substring, or -1 if not found

### findOneOf

()
method

`public static function findOneOf(cset:String, str:String):int`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Finds the first occurrence of any one of a set of characters in a string. The search is case-sensitive.

Parameters

| `cset:String` — Set of characters to look for
| `str:String` — String

Returns

| `int` — Position of the first member of set found in string; or -1, if no member of set is found in string.

### insert

()
method

`public static function insert(sub:String, str:String, pos:int):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Inserts a substring in a string after a specified character position. If position = -1, prefixes the substring to the string.

Parameters

| `sub:String` — String to insert
| `str:String` — String
| `pos:int` — Position to insert the substring

Returns

| `String` — New string

### left

()
method

`public static function left(str:String, count:int):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Gets the leftmost characters from a string.

Parameters

| `str:String` — String
| `count:int` — How many characters

Returns

| `String` — Leftmost count characters of the given string

### leftTrim

()
method

`public static function leftTrim(input:String):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Removes whitespace from the front of the specified string.

Parameters

| `input:String` — String whose beginning whitespace will be removed.

Returns

| `String` — String with whitespace removed from the begining

### len

()
method

`public static function len(s:String):int`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns the length of a string.

Parameters

| `s:String` — String

Returns

| `int` — Length

### lower

()
method

`public static function lower(str:String):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Converts a string to lowercase.

Parameters

| `str:String` — String

Returns

| `String` — String, converted to lowercase.

### removeChars

()
method

`public static function removeChars(str:String, start:int, count:int):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns a copy of the string, with count characters removed from the specified start position. If start or count is invalid, the original string is returned.

Parameters

| `str:String` — String
| `start:int` — Starting character to remove
| `count:int` — Number of characters to remove

Returns

| `String` — New string with the characters removed

### repeatString

()
method

`public static function repeatString(str:String, count:int):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Creates a string that contains a specified number of repetitions of the specified string.

Parameters

| `str:String` — String
| `count:int` — Number of times to repeat str

Returns

| `String` — New string

### replace

()
method

`public static function replace(input:String, search:String, replace:String):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Replaces first occurrence of search in the input string with replace. The search is case-sensitive.

Parameters

| `input:String` — String to search
| `search:String` — What to look for
| `replace:String` — What to replace it with

Returns

| `String` — New string

### replaceAll

()
method

`public static function replaceAll(input:String, search:String, replace:String):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Replaces all occurrences of search in the input string with replace. The search is case-sensitive.

Parameters

| `input:String` — String to search
| `search:String` — What to look for
| `replace:String` — What to replace it with

Returns

| `String` — New string

### replaceAllNoCase

()
method

`public static function replaceAllNoCase(input:String, search:String, replace:String):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Replaces all occurrences of search in the input string with replace. The search is case-insensitive.

Parameters

| `input:String` — String to search
| `search:String` — What to look for
| `replace:String` — What to replace it with

Returns

| `String` — New string

### replaceNoCase

()
method

`public static function replaceNoCase(input:String, search:String, replace:String):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Replaces first occurrence of search in the input string with replace. The search is case-insensitive.

Parameters

| `input:String` — String to search
| `search:String` — What to look for
| `replace:String` — What to replace it with

Returns

| `String` — New string

### reverse

()
method

`public static function reverse(s:String):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Reverse the characters in a string.

Parameters

| `s:String` — String

Returns

| `String` — New string with the characters in reverse order

### right

()
method

`public static function right(str:String, count:int):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns the specified number of characters from the end (or right side) of the specified string.

Parameters

| `str:String` — String
| `count:int` — Number of rightmost characters

Returns

| `String` — Rightmost count characters of the given string

### rightTrim

()
method

`public static function rightTrim(input:String):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Removes trailing white space from a string.

Parameters

| `input:String` — String to trim

Returns

| `String` — String with trailing whitespace removed

### spanExcluding

()
method

`public static function spanExcluding(str:String, cset:String):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Gets characters from a string, from the beginning to a character that is in a specified set of characters. The search is case-sensitive. Example SpanExcluding("MyString", "Sin") will return "My" as after that it hits 'S' which is present in 2nd string.

Parameters

| `str:String` — String
| `cset:String` — Set of characters to stop on

Returns

| `String` — Substring of str

### spanIncluding

()
method

`public static function spanIncluding(str:String, cset:String):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Gets characters from a string, from the beginning to a character that is not in a specified set of characters. The search is case-sensitive. example : SpanIncluding("mystring", "mystery") will return "mystr"

Parameters

| `str:String` — String
| `cset:String` — Set of characters to include

Returns

| `String` — Substring of str

### startsWith

()
method

`public static function startsWith(prefix:String, input:String):Boolean`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns true if string starts with a specified prefix.

Parameters

| `prefix:String` — Prefix string
| `input:String` — String

Returns

| `Boolean` — true if the string starts with prefix

### substring

()
method

`public static function substring(str:String, s:int, c:int):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Extracts a substring from a string, beginning at s (start), of length c (count).

Parameters

| `str:String` — String
| `s:int` — First character to extract (indexes start at 0)
| `c:int` — Number of characters

Returns

| `String` — Substring

### trim

()
method

`public static function trim(s:String):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Removes whitespace from the start and end of a string.

Parameters

| `s:String` — String

Returns

| `String` — Copy of the string with no leading or trailing whitespace

### upper

()
method

`public static function upper(s:String):String`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Converts a string to uppercase.

Parameters

| `s:String` — String

Returns

| `String` — String converted to uppercase

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00