default
core
core
core.ObjectArray
add(Object o) : boolean
- Add the given object value to this arraylist.
alloc(int max) : boolean
- Allocate the given number of array elements.
containsObject(Object o) : boolean
- Check whether array contains an object that equals the given object.
containsPointer(Object o) : boolean
- Check whether array contains the given object address.
delete(int index) : boolean
- Delete the array element at the given index.
empty()
- Reset the number of used elements, numElements, to 0.
free()
- Free all array elements
get(int index) : Object
- Return a reference to array element at the given index.
getDeref(int index) : Object
- Return a deletable reference to array elements at the given index.
getFirst() : Object
- Return first array element.
getLast() : Object
- Return last used array element.
getMaxElements() : int
- Return the total number of elements.
getNextFree() : Object
- Return a reference to the next free object.
getNumElements() : int
- Return the number of used elements.
getString() : String
- Return a string representation of this ObjectArray.
getTemplate() : Object
- Return the template object that is currently being used for allocations of new objects.
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, Object o) : boolean
- Insert the given object before the given index.
realloc(int max) : boolean
- Reallocate array.
remove(Object o) : boolean
- Delete the first element whose object pointer equals the given pointer.
reverse()
- Reverse the element order.
setNumElements(int num)
- Set the number of used array elements.
setTemplate(Object template)
- Set the template object to use for allocation of new array objects.
swap(int indexA, indexB) : boolean
- Swap two array elements
useAll()
- Mark all array elements used, i.e. set numElements = maxElements.
A template object is used to allocate new objects.
Method add | ||||||||||
Add the given object value to this arraylist. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
Returns | ||||||||||
| ||||||||||
Description | ||||||||||
The array will be reallocated if necessary. |
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 array contains an object that equals the given object. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method containsPointer | ||||||||||
Check whether array contains the given object address. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method delete | ||||||||||
Delete the array 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 array element at the given index. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Description | ||||||||||
Silently return null if "index" exceeds the array bounds. |
Method getDeref | ||||||||||
Return a deletable reference to array elements at the given index. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Description | ||||||||||
Silently return null if "index" exceeds the array bounds. |
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 a reference to the next free object. | |||||
Signature | |||||
| |||||
Returns | |||||
| |||||
Description | |||||
Increase numElements. |
Method getNumElements | |||||
Return the number of used elements. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getString | |||||
Return a string representation of this ObjectArray. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getTemplate | |||||
Return the template object that is currently being used for allocations of new objects. | |||||
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 the given object before the given index. | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
Returns | ||||||||||||||||||||
| ||||||||||||||||||||
Description | ||||||||||||||||||||
The array will be reallocated if necessary. |
Method realloc | ||||||||||
Reallocate array. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Description | ||||||||||
Discard/add empty elements as required. |
Method remove | ||||||||||
Delete the first element whose object pointer equals the given pointer. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method reverse | |||
Reverse the element order. | |||
Signature | |||
|
Method setNumElements | |||||
Set the number of used array elements. | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setTemplate | |||||
Set the template object to use for allocation of new array objects. | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method swap | ||||||||||||||||||||
Swap two array elements | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
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