CPArray Class Reference
[Foundation]
List of all members.
Detailed Description
A mutable array class backed by a JavaScript Array. There is also a
CPMutableArray class, but it is just a child class of this class with an empty implementation. All mutable functionality is implemented directly in
CPArray.
Definition at line 266 of file CPArray+KVO.j.
Member Function Documentation
+ (id) array |
|
|
|
[implementation] |
- (CPArray) arrayByAddingObject: |
|
(id) |
anObject |
|
[implementation] |
Returns a copy of this array plus anObject
inside the copy.
- Parameters:
-
| anObject | the object to be added to the array copy |
- Exceptions:
-
| CPInvalidArgumentException | if anObject is nil |
- Returns:
- a new array that should be n+1 in size compared to the receiver.
Definition at line 677 of file CPArray.j.
- (CPArray) arrayByAddingObjectsFromArray: |
|
(CPArray) |
anArray |
|
[implementation] |
Returns a new array which is the concatenation of self
and otherArray (in this precise order).
- Parameters:
-
| anArray | the array that will be concatenated to the receiver's copy |
Definition at line 694 of file CPArray.j.
+ (id) arrayWithArray: |
|
(CPArray) |
anArray |
|
[implementation] |
Creates a new array containing the objects in anArray
.
- Parameters:
-
| anArray | Objects in this array will be added to the new array |
- Returns:
- a new CPArray of the provided objects
Definition at line 121 of file CPArray.j.
+ (id) arrayWithObject: |
|
(id) |
anObject |
|
[implementation] |
Creates a new array with anObject
in it.
- Parameters:
-
| anObject | the object to be added to the array |
- Returns:
- a new CPArray containing a single object
Definition at line 131 of file CPArray.j.
+ (id) arrayWithObjects: |
|
(id) |
anObject |
, |
|
|
... | |
|
|
| | [implementation] |
Creates a new CPArray containing all the objects passed as arguments to the method.
- Parameters:
-
| anObject | the objects that will be added to the new array |
- Returns:
- a new CPArray containing the argument objects
Definition at line 141 of file CPArray.j.
+ (id) arrayWithObjects: |
|
(id) |
objects |
count: |
|
(unsigned) |
aCount | |
|
|
| | [implementation] |
Creates a CPArray from a JavaScript array of objects.
- Parameters:
-
| objects | the JavaScript Array |
| aCount | the number of objects in the JS Array |
- Returns:
- a new CPArray containing the specified objects
Definition at line 159 of file CPArray.j.
Returns a string formed by concatenating the objects in the receiver, with the specified separator string inserted between each part. If the element is a Objective-J object, then the description
of that object will be used, otherwise the default JavaScript representation will be used.
- Parameters:
-
| aString | the separator that will separate each object string |
- Returns:
- the string representation of the array
Definition at line 788 of file CPArray.j.
- (BOOL) containsObject: |
|
(id) |
anObject |
|
[implementation] |
Returns YES
if the array contains anObject
. Otherwise, it returns NO
.
- Parameters:
-
| anObject | the method checks if this object is already in the array |
Definition at line 275 of file CPArray.j.
- (id) copy |
|
|
|
[implementation] |
Makes a copy of the receiver.
- Returns:
- a new CPArray copy
Definition at line 876 of file CPArray.j.
- (int) count |
|
|
|
[implementation] |
Returns the number of elements in the array
Definition at line 283 of file CPArray.j.
- (CPString) description |
|
|
|
[implementation] |
Returns a human readable description of this array and it's elements.
Definition at line 800 of file CPArray.j.
- (void) encodeWithCoder: |
|
(CPCoder) |
aCoder |
|
[implementation] |
- (id) firstObjectCommonWithArray: |
|
(CPArray) |
anArray |
|
[implementation] |
Returns the first object found in the receiver (starting at index 0) which is present in the otherArray
as determined by using the -containsObject:
method.
- Returns:
- the first object found, or
nil
if no common object was found.
Definition at line 617 of file CPArray.j.
- (unsigned) hash |
|
|
|
[implementation] |
Returns a hash of the CPArray.
- Returns:
- an unsigned integer hash
Definition at line 262 of file CPArray.j.
- (int) indexOfObject: |
|
(id) |
anObject |
|
[implementation] |
Returns the index of anObject
in this array. If the object is nil
or not in the array, returns CPNotFound
. It first attempts to find a match using isEqual:
, then ==
.
- Parameters:
-
| anObject | the object to search for |
Definition at line 295 of file CPArray.j.
- (int) indexOfObject: |
|
(id) |
anObject |
inRange: |
|
(CPRange) |
aRange | |
|
|
| | [implementation] |
Returns the index of anObject
in the array within aRange
. It first attempts to find a match using isEqual:
, then ==
.
- Parameters:
-
| anObject | the object to search for |
| aRange | the range to search within |
- Returns:
- the index of the object, or
CPNotFound
if it was not found.
Definition at line 331 of file CPArray.j.
- (unsigned) indexOfObject: |
|
(id) |
anObject |
sortedByDescriptors: |
|
(CPArray) |
descriptors | |
|
|
| | [implementation] |
Returns the index of anObject
in the array, which must be sorted in the same order as calling sortUsingDescriptors: with the descriptors passed to this method would result in.
- Parameters:
-
| anObject | the object to search for |
| descriptors | the array of descriptors to use to compare each item in the array that we search. the same descriptors should have been used to sort the array (or to maintain its sorted order). |
- Returns:
- the index of the object, or
CPNotFound
if it was not found.
Definition at line 499 of file CPArray.j.
- (unsigned) indexOfObject: |
|
(id) |
anObject |
sortedByFunction: |
|
(Function) |
aFunction | |
|
|
| | [implementation] |
Returns the index of anObject
in the array, which must be sorted in the same order as calling sortUsingFunction: with the selector passed to this method would result in. The function will be called like so:
aFunction(anObject, currentObjectInArrayForComparison)
- Parameters:
-
| anObject | the object to search for |
| aFunction | the comparison function to call on each item in the array that we search. the same selector should have been used to sort the array (or to maintain its sorted order). |
- Returns:
- the index of the object, or
CPNotFound
if it was not found.
Definition at line 446 of file CPArray.j.
- (unsigned) indexOfObject: |
|
(id) |
anObject |
sortedByFunction: |
|
(Function) |
aFunction |
context: |
|
(id) |
aContext | |
|
|
| | [implementation] |
Returns the index of anObject
in the array, which must be sorted in the same order as calling sortUsingFunction: with the selector passed to this method would result in. The function will be called like so:
aFunction(anObject, currentObjectInArrayForComparison, context)
- Parameters:
-
| anObject | the object to search for |
| aFunction | the comparison function to call on each item in the array that we search. the same function should have been used to sort the array (or to maintain its sorted order). |
| aContext | a context object that will be passed to the sort function |
- Returns:
- the index of the object, or
CPNotFound
if it was not found.
Definition at line 464 of file CPArray.j.
- (unsigned) indexOfObject: |
|
(id) |
anObject |
sortedBySelector: |
|
(SEL) |
aSelector | |
|
|
| | [implementation] |
Returns the index of anObject
in the array, which must be sorted in the same order as calling sortUsingSelector: with the selector passed to this method would result in.
- Parameters:
-
| anObject | the object to search for |
| aSelector | the comparison selector to call on each item in the list, the same selector should have been used to sort the array (or to maintain its sorted order). |
- Returns:
- the index of the object, or
CPNotFound
if it was not found.
Definition at line 429 of file CPArray.j.
- (int) indexOfObjectIdenticalTo: |
|
(id) |
anObject |
|
[implementation] |
Returns the index of anObject
in the array. The test for equality is done using only ==
.
- Parameters:
-
| anObject | the object to search for |
- Returns:
- the index of the object in the array.
CPNotFound
if the object is not in the array.
Definition at line 360 of file CPArray.j.
- (int) indexOfObjectIdenticalTo: |
|
(id) |
anObject |
inRange: |
|
(CPRange) |
aRange | |
|
|
| | [implementation] |
Returns the index of anObject
in the array within aRange
. The test for equality is done using only ==
.
- Parameters:
-
| anObject | the object to search for |
| aRange | the range to search within |
- Returns:
- the index of the object, or
CPNotFound
if it was not found.
Definition at line 392 of file CPArray.j.
- (id) init |
|
|
|
[implementation] |
Initializes the CPArray.
- Returns:
- the initialized array
Definition at line 168 of file CPArray.j.
- (id) initWithArray: |
|
(CPArray) |
anArray |
|
[implementation] |
Creates a new CPArray from anArray
.
- Parameters:
-
| anArray | objects in this array will be added to the new array |
- Returns:
- a new CPArray containing the objects of
anArray
Definition at line 179 of file CPArray.j.
- (id) initWithArray: |
|
(CPArray) |
anArray |
copyItems: |
|
(BOOL) |
copyItems | |
|
|
| | [implementation] |
Initializes a the array with the contents of anArray
and optionally performs a deep copy of the objects based on copyItems
.
- Parameters:
-
| anArray | the array to copy the data from |
| copyItems | if YES , each object will be copied by having a copy message sent to it, and the returned object will be added to the receiver. Otherwise, no copying will be performed. |
- Returns:
- the initialized array of objects
Definition at line 197 of file CPArray.j.
- (id) initWithCoder: |
|
(CPCoder) |
aCoder |
|
[implementation] |
- (id) initWithObjects: |
|
(Array) |
anArray |
, |
|
|
... | |
|
|
| | [implementation] |
initializes an array with the contents of anArray
Definition at line 225 of file CPArray.j.
- (id) initWithObjects: |
|
(id) |
objects |
count: |
|
(unsigned) |
aCount | |
|
|
| | [implementation] |
Initializes the array with a JavaScript array of objects.
- Parameters:
-
| objects | the array of objects to add to the receiver |
| aCount | the number of objects in objects |
- Returns:
- the initialized CPArray
Definition at line 243 of file CPArray.j.
- (BOOL) isEqual: |
|
(id) |
anObject |
|
[implementation] |
- (BOOL) isEqualToArray: |
|
(id) |
anArray |
|
[implementation] |
Returns true if anArray contains exactly the same objects as the reciever.
Definition at line 635 of file CPArray.j.
- (id) lastObject |
|
|
|
[implementation] |
Returns the last object in the array. If the array is empty, returns nil
/
Definition at line 518 of file CPArray.j.
- (void) makeObjectsPerformSelector: |
|
(SEL) |
aSelector |
|
[implementation] |
Sends each element in the array a message.
- Parameters:
-
| aSelector | the selector of the message to send |
- Exceptions:
-
| CPInvalidArgumentException | if aSelector is nil |
Definition at line 581 of file CPArray.j.
- (void) makeObjectsPerformSelector: |
|
(SEL) |
aSelector |
withObject: |
|
(id) |
anObject | |
|
|
| | [implementation] |
Sends each element in the array a message with an argument.
- Parameters:
-
| aSelector | the selector of the message to send |
| anObject | the first argument of the message |
- Exceptions:
-
| CPInvalidArgumentException | if aSelector is nil |
Definition at line 599 of file CPArray.j.
- (id) objectAtIndex: |
|
(int) |
anIndex |
|
[implementation] |
Returns the object at index anIndex
.
- Exceptions:
-
| CPRangeException | if anIndex is out of bounds |
Definition at line 531 of file CPArray.j.
Returns an enumerator describing the array sequentially from the first to the last element. You should not modify the array during enumeration.
Definition at line 560 of file CPArray.j.
Returns the objects at indexes
in a new CPArray.
- Parameters:
-
| indexes | the set of indices |
- Exceptions:
-
| CPRangeException | if any of the indices is greater than or equal to the length of the array |
Definition at line 541 of file CPArray.j.
- (CPArray) pathsMatchingExtensions: |
|
(CPArray) |
filterTypes |
|
[implementation] |
Returns a new array subset formed by selecting the elements that have filename extensions from filterTypes
. Only elements that are of type CPString are candidates for inclusion in the returned array.
- Parameters:
-
| filterTypes | an array of CPString objects that contain file extensions (without the '.') |
- Returns:
- a new array with matching paths
Definition at line 825 of file CPArray.j.
Returns an enumerator describing the array sequentially from the last to the first element. You should not modify the array during enumeration.
Definition at line 570 of file CPArray.j.
- (void) setValue: |
|
(id) |
aValue |
forKey: |
|
(CPString) |
aKey | |
|
|
| | [implementation] |
Sets the key-value for each element in the array.
- Parameters:
-
| aValue | the value for the coding |
| aKey | the key for the coding |
Definition at line 334 of file CPArray+KVO.j.
- (void) setValue: |
|
(id) |
aValue |
forKeyPath: |
|
(CPString) |
aKeyPath | |
|
|
| | [implementation] |
- (CPArray) sortedArrayUsingDescriptors: |
|
(CPArray) |
descriptors |
|
[implementation] |
- (CPArray) sortedArrayUsingFunction: |
|
(Function) |
aFunction |
|
[implementation] |
Return a copy of the receiver sorted using the function passed into the first parameter.
Definition at line 743 of file CPArray.j.
- (CPArray) sortedArrayUsingFunction: |
|
(Function) |
aFunction |
context: |
|
(id) |
aContext | |
|
|
| | [implementation] |
Returns an array in which the objects are ordered according to a sort with aFunction
. This invokes -sortUsingFunction:context
.
- Parameters:
-
| aFunction | a JavaScript 'Function' type that compares objects |
| aContext | context information |
- Returns:
- a new sorted array
Definition at line 756 of file CPArray.j.
- (CPArray) sortedArrayUsingSelector: |
|
(SEL) |
aSelector |
|
[implementation] |
Returns a new array in which the objects are ordered according to a sort with aSelector
.
- Parameters:
-
| aSelector | the selector that will perform object comparisons |
Definition at line 769 of file CPArray.j.
- (CPArray) subarrayWithRange: |
|
(CPRange) |
aRange |
|
[implementation] |
Returns a subarray of the receiver containing the objects found in the specified range aRange
.
- Parameters:
-
| aRange | the range of objects to be copied into the subarray |
- Exceptions:
-
| CPRangeException | if the specified range exceeds the bounds of the array |
Definition at line 719 of file CPArray.j.
Returns the value for aKey
from each element in the array.
- Parameters:
-
| aKey | the key to return the value for |
- Returns:
- an array of containing a value for each element in the array
Definition at line 268 of file CPArray+KVO.j.
- (id) valueForKeyPath: |
|
(CPString) |
aKeyPath |
|
[implementation] |
The documentation for this class was generated from the following files: