default
core
core
core.StringArray
add(String s) : boolean
- Add a copy of the given string to this arraylist.
addEmpty(int num) : int
- Increase the number of used elements.
alloc(int max) : boolean
- Allocate the given number of array elements.
containsObject(String s) : boolean
- Check whether this array contains the given String. @yacEquals is used to compare to the given string.
containsPointer(String s) : boolean
- Check whether this array contains the given String address.
delete(int index) : boolean
- Delete element at the given index.
empty()
- Reset the number of used elements, numElements, to 0.
free()
- Free all array elements.
get(int index) : String
- Return a reference to an array element.
getCopy(int index) : String
- Return a copy of an array element.
getFirst() : Object
- Return first array element.
getLast() : Object
- Return last used array element.
getMaxElements() : int
- Return the total number of elements
getNextFree() : String
- Return next free String.
getNumElements() : int
- Return the number of used elements.
getString() : String
- Return string representation of this array.
indexOfObject(Object o) : int
- Return the index of the element that equals the given object.
indexOfPointer(Object o) : int
- Return the index of the element that points to the given object.
insert(int index, String s) : boolean
- Insert a copy of the given String into this array.
join(Object a, b)
- Join arrays 'a' and 'b'.
realloc(int max) : boolean
- Reallocate array.
rearrange(IntArray order) : boolean
- Rearrange array elements according to given order array.
reverse()
- Reverse element order.
setNumElements(int num)
- Set number of used elements.
sortByLength(IntArray order)
- Sort strings by length and write new element order to "order".
sortByValue(IntArray order, boolean bCaseSensitive)
- Sort strings by content and write new element order to "order".
swap(int indexA, indexB) : boolean
- Swap two array elements.
unset()
- Empty all Strings
useAll()
- Mark all array elements used, i.e. set numElements = maxElements.
Method add | ||||||||||
Add a copy of the given string to this arraylist. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Description | ||||||||||
The array will be resized as required. |
Method addEmpty | ||||||||||
Increase the number of used elements. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Description | ||||||||||
This method will not reallocate the array. |
Method alloc | ||||||||||
Allocate the given number of array elements. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Description | ||||||||||
All previous elements will be discarded. The number of used elements, numElements, will be reset to 0. |
Method containsObject | ||||||||||
Check whether this array contains the given String. @yacEquals is used to compare to the given string. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method containsPointer | ||||||||||
Check whether this array contains the given String address. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method delete | ||||||||||
Delete element at the given index. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method empty | |||
Reset the number of used elements, numElements, to 0. | |||
Signature | |||
|
Method free | |||
Free all array elements. | |||
Signature | |||
|
Method get | ||||||||||
Return a reference to an array element. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Description | ||||||||||
Silently return null if the given index is out of bounds. |
Method getCopy | ||||||||||
Return a copy of an array element. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method getFirst | |||||
Return first array element. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getLast | |||||
Return last used array element. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getMaxElements | |||||
Return the total number of elements | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getNextFree | |||||
Return next free String. | |||||
Signature | |||||
| |||||
Returns | |||||
| |||||
Description | |||||
Increase numElements. |
Method getNumElements | |||||
Return the number of used elements. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getString | |||||
Return string representation of this array. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method indexOfObject | ||||||||||
Return the index of the element that equals the given object. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method indexOfPointer | ||||||||||
Return the index of the element that points to the given object. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method insert | ||||||||||||||||||||
Insert a copy of the given String into this array. | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
Method join | |
Join arrays 'a' and 'b'. | |
Signature | |
Arguments | |
Method realloc | ||||||||||
Reallocate array. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Description | ||||||||||
Discard/add elements as required. |
Method rearrange | ||||||||||
Rearrange array elements according to given order array. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method reverse | |||
Reverse element order. | |||
Signature | |||
|
Method setNumElements | |||||
Set number of used elements. | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method sortByLength | |||||
Sort strings by length and write new element order to "order". | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method sortByValue | |||||||||||||||
Sort strings by content and write new element order to "order". | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method swap | ||||||||||||||||||||
Swap two array elements. | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
Method unset | |||
Empty all Strings | |||
Signature | |||
|
Method useAll | |||
Mark all array elements used, i.e. set numElements = maxElements. | |||
Signature | |||
|
auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 13:15:54