API 0.9.5
CPArray Class Reference

A mutable array backed by a JavaScript Array.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. More...

#import <CPArray.h>

Inheritance diagram for CPArray:

List of all members.

Instance Methods

(CPArray- arrayByAddingObject:
(CPArray- arrayByAddingObjectsFromArray:
(CPString- componentsJoinedByString:
(BOOL) - containsObject:
(BOOL) - containsObjectIdenticalTo:
(id) - copy
(int) - count
(CPString- description
(void) - encodeWithCoder:
(void) - enumerateObjectsUsingBlock:
(CPArray- filteredArrayUsingPredicate:
(void) - filterUsingPredicate:
(id) - firstObject
(id) - firstObjectCommonWithArray:
(CPUInteger) - indexOfObject:
(CPUInteger) - indexOfObject:inRange:
(CPUInteger) - indexOfObject:inSortedRange:options:usingComparator:
(CPUInteger) - indexOfObjectIdenticalTo:
(CPUInteger) - indexOfObjectIdenticalTo:inRange:
(unsigned) - indexOfObjectPassingTest:
(unsigned) - indexOfObjectPassingTest:context:
(unsigned) - indexOfObjectWithOptions:passingTest:
(unsigned) - indexOfObjectWithOptions:passingTest:context:
(id) - init
(id) - initWithArray:
(id) - initWithArray:copyItems:
(id) - initWithCapacity:
(id) - initWithCoder:
(id) - initWithObjects:
(id) - initWithObjects:count:
(BOOL) - isEqual:
(BOOL) - isEqualToArray:
(id) - lastObject
(void) - makeObjectsPerformSelector:
(void) - makeObjectsPerformSelector:withObject:
(void) - makeObjectsPerformSelector:withObjects:
(id) - mutableCopy
(id) - objectAtIndex:
(CPEnumerator- objectEnumerator
(CPArray- objectsAtIndexes:
(CPArray- pathsMatchingExtensions:
(CPEnumerator- reverseObjectEnumerator
(void) - setValue:forKey:
(void) - setValue:forKeyPath:
(CPArray- sortedArrayUsingDescriptors:
(CPArray- sortedArrayUsingFunction:
(CPArray- sortedArrayUsingFunction:context:
(CPArray- sortedArrayUsingSelector:
(CPArray- subarrayWithRange:
(id) - valueForKey:
(id) - valueForKeyPath:

Class Methods

(id) + alloc
(id) + array
(id) + arrayWithArray:
(id) + arrayWithObject:
(id) + arrayWithObjects:
(id) + arrayWithObjects:count:

Detailed Description

A mutable array backed by a JavaScript Array.

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 2 of file CPArray.h.


Method Documentation

+ (id) alloc

Returns a new uninitialized CPArray.

Definition at line 64 of file CPArray.j.

+ (id) array

Returns a new initialized CPArray.

Definition at line 75 of file CPArray.j.

- (CPArray) arrayByAddingObject: (id)  anObject

Returns a copy of this array plus anObject inside the copy.

Parameters:
anObjectthe object to be added to the array copy
Exceptions:
CPInvalidArgumentExceptionif anObject is nil
Returns:
a new array that should be n+1 in size compared to the receiver.

Definition at line 628 of file CPArray.j.

- (CPArray) arrayByAddingObjectsFromArray: (CPArray anArray

Returns a new array which is the concatenation of self and otherArray (in this precise order).

Parameters:
anArraythe array that will be concatenated to the receiver's copy

Definition at line 643 of file CPArray.j.

+ (id) arrayWithArray: (CPArray anArray

Creates a new array containing the objects in anArray.

Parameters:
anArrayObjects in this array will be added to the new array
Returns:
a new CPArray of the provided objects

Definition at line 85 of file CPArray.j.

+ (id) arrayWithObject: (id)  anObject

Creates a new array with anObject in it.

Parameters:
anObjectthe object to be added to the array
Returns:
a new CPArray containing a single object

Definition at line 95 of file CPArray.j.

+ (id) arrayWithObjects: (id)  anObject
,   ... 

Creates a new CPArray containing all the objects passed as arguments to the method.

Parameters:
anObjectthe objects that will be added to the new array
Returns:
a new CPArray containing the argument objects

Definition at line 105 of file CPArray.j.

+ (id) arrayWithObjects: (id)  objects
count: (unsigned)  aCount 

Creates a CPArray from a JavaScript array of objects.

Parameters:
objectsthe JavaScript Array
aCountthe number of objects in the JS Array
Returns:
a new CPArray containing the specified objects

Definition at line 119 of file CPArray.j.

- (CPString) componentsJoinedByString: (CPString aString

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:
aStringthe separator that will separate each object string
Returns:
the string representation of the array

Definition at line 753 of file CPArray.j.

- (BOOL) containsObject: (id)  anObject

Returns YES if the array contains anObject. Otherwise, it returns NO.

Parameters:
anObjectthe method checks if this object is already in the array

Definition at line 187 of file CPArray.j.

- (BOOL) containsObjectIdenticalTo: (id)  anObject

Definition at line 192 of file CPArray.j.

- (id) copy

Makes a copy of the receiver.

Returns:
a new CPArray copy

Definition at line 815 of file CPArray.j.

- (int) count

Returns the number of elements in the array

Definition at line 200 of file CPArray.j.

- (CPString) description

Returns a human readable description of this array and it's elements.

Definition at line 763 of file CPArray.j.

- (void) encodeWithCoder: (CPCoder aCoder

Definition at line 829 of file CPArray.j.

- (void) enumerateObjectsUsingBlock: (Function)  aFunction

Definition at line 537 of file CPArray.j.

- (CPArray) filteredArrayUsingPredicate: (CPPredicate predicate

Definition at line 186 of file CPPredicate.j.

- (void) filterUsingPredicate: (CPPredicate predicate

Definition at line 202 of file CPPredicate.j.

- (id) firstObject

Returns the first object in the array. If the array is empty, returns nil

Definition at line 208 of file CPArray.j.

- (id) firstObjectCommonWithArray: (CPArray anArray

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 552 of file CPArray.j.

- (CPUInteger) indexOfObject: (id)  anObject

Returns the index of anObject in this array. If the object is not in the array, returns CPNotFound. It first attempts to find a match using -isEqual:, then ===.

Parameters:
anObjectthe object to search for

Definition at line 283 of file CPArray.j.

- (CPUInteger) indexOfObject: (id)  anObject
inRange: (CPRange)  aRange 

Returns the index of anObject in the array within aRange. It first attempts to find a match using -isEqual:, then ===.

Parameters:
anObjectthe object to search for
aRangethe range to search within
Returns:
the index of the object, or CPNotFound if it was not found.

Definition at line 296 of file CPArray.j.

- (CPUInteger) indexOfObject: (id)  anObject
inSortedRange: (CPRange)  aRange
options: (CPBinarySearchingOptions)  options
usingComparator: (Function)  aComparator 

Definition at line 427 of file CPArray.j.

- (CPUInteger) indexOfObjectIdenticalTo: (id)  anObject

Returns the index of anObject in the array. The test for equality is done using only ===.

Parameters:
anObjectthe 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 319 of file CPArray.j.

- (CPUInteger) indexOfObjectIdenticalTo: (id)  anObject
inRange: (CPRange)  aRange 

Returns the index of anObject in the array within aRange. The test for equality is done using only ==.

Parameters:
anObjectthe object to search for
aRangethe range to search within
Returns:
the index of the object, or CPNotFound if it was not found.

Definition at line 332 of file CPArray.j.

- (unsigned) indexOfObjectPassingTest: (Function)  aPredicate

Returns the index of the first object in the receiver that passes a test in a given Javascript function.

Parameters:
predicateThe function to apply to elements of the array. The function receives two arguments: object The element in the array. index The index of the element in the array. The predicate function should either return a Boolean value that indicates whether the object passed the test, or nil to stop the search, which will return CPNotFound to the sender.
Returns:
The index of the first matching object, or CPNotFound if there is no matching object.

Definition at line 353 of file CPArray.j.

- (unsigned) indexOfObjectPassingTest: (Function)  aPredicate
context: (id)  aContext 

Returns the index of the first object in the receiver that passes a test in a given Javascript function.

Parameters:
predicateThe function to apply to elements of the array. The function receives two arguments: object The element in the array. index The index of the element in the array. context The object passed to the receiver in the aContext parameter. The predicate function should either return a Boolean value that indicates whether the object passed the test, or nil to stop the search, which will return CPNotFound to the sender.
contextAn object that contains context information you want passed to the predicate function.
Returns:
The index of the first matching object, or CPNotFound if there is no matching object.

Definition at line 369 of file CPArray.j.

- (unsigned) indexOfObjectWithOptions: (CPEnumerationOptions)  options
passingTest: (Function)  aPredicate 

Returns the index of the first object in the receiver that passes a test in a given Javascript function.

Parameters:
optionsSpecifies the direction in which the array is searched. Pass CPEnumerationNormal to search forwards or CPEnumerationReverse to search in reverse.
predicateThe function to apply to elements of the array. The function receives two arguments: object The element in the array. index The index of the element in the array. The predicate function should either return a Boolean value that indicates whether the object passed the test, or nil to stop the search, which will return CPNotFound to the sender.
Returns:
The index of the first matching object, or CPNotFound if there is no matching object.

Definition at line 385 of file CPArray.j.

- (unsigned) indexOfObjectWithOptions: (CPEnumerationOptions)  options
passingTest: (Function)  aPredicate
context: (id)  aContext 

Returns the index of the first object in the receiver that passes a test in a given Javascript function.

Parameters:
optionsSpecifies the direction in which the array is searched. Pass CPEnumerationNormal to search forwards or CPEnumerationReverse to search in reverse.
predicateThe function to apply to elements of the array. The function receives two arguments: object The element in the array. index The index of the element in the array. context The object passed to the receiver in the aContext parameter. The predicate function should either return a Boolean value that indicates whether the object passed the test, or nil to stop the search, which will return CPNotFound to the sender.
contextAn object that contains context information you want passed to the predicate function.
Returns:
The index of the first matching object, or CPNotFound if there is no matching object.

Definition at line 403 of file CPArray.j.

- (id) init

Initializes the CPArray.

Returns:
the initialized array

Definition at line 128 of file CPArray.j.

- (id) initWithArray: (CPArray anArray

Creates a new CPArray from anArray.

Parameters:
anArrayobjects in this array will be added to the new array
Returns:
a new CPArray containing the objects of anArray

Definition at line 139 of file CPArray.j.

- (id) initWithArray: (CPArray anArray
copyItems: (BOOL)  shouldCopyItems 

Initializes a the array with the contents of anArray and optionally performs a deep copy of the objects based on copyItems.

Parameters:
anArraythe array to copy the data from
shouldCopyItemsif 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 152 of file CPArray.j.

- (id) initWithCapacity: (unsigned)  aCapacity

Definition at line 177 of file CPArray.j.

- (id) initWithCoder: (CPCoder aCoder

Definition at line 824 of file CPArray.j.

- (id) initWithObjects: (id)  anObject
,   ... 

initializes an array with the contents of anArray

Definition at line 160 of file CPArray.j.

- (id) initWithObjects: (id)  objects
count: (unsigned)  aCount 

Initializes the array with a JavaScript array of objects.

Parameters:
objectsthe array of objects to add to the receiver
aCountthe number of objects in objects
Returns:
the initialized CPArray

Definition at line 171 of file CPArray.j.

- (BOOL) isEqual: (id)  anObject

Definition at line 604 of file CPArray.j.

- (BOOL) isEqualToArray: (id)  anArray

Returns true if anArray contains exactly the same objects as the receiver.

Definition at line 575 of file CPArray.j.

- (id) lastObject

Returns the last object in the array. If the array is empty, returns nil

Definition at line 221 of file CPArray.j.

- (void) makeObjectsPerformSelector: (SEL)  aSelector

Sends each element in the array a message.

Parameters:
aSelectorthe selector of the message to send
Exceptions:
CPInvalidArgumentExceptionif aSelector is nil

Definition at line 496 of file CPArray.j.

- (void) makeObjectsPerformSelector: (SEL)  aSelector
withObject: (id)  anObject 

Sends each element in the array a message with an argument.

Parameters:
aSelectorthe selector of the message to send
anObjectthe first argument of the message
Exceptions:
CPInvalidArgumentExceptionif aSelector is nil

Definition at line 507 of file CPArray.j.

- (void) makeObjectsPerformSelector: (SEL)  aSelector
withObjects: (CPArray objects 

Definition at line 512 of file CPArray.j.

- (id) mutableCopy

Definition at line 402 of file CPMutableArray.j.

- (id) objectAtIndex: (int)  anIndex

Returns the object at index anIndex.

Exceptions:
CPRangeExceptionif anIndex is out of bounds

Definition at line 235 of file CPArray.j.

- (CPEnumerator) objectEnumerator

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 261 of file CPArray.j.

- (CPArray) objectsAtIndexes: (CPIndexSet indexes

Returns the objects at indexes in a new CPArray.

Parameters:
indexesthe set of indices
Exceptions:
CPRangeExceptionif any of the indices is greater than or equal to the length of the array

Definition at line 245 of file CPArray.j.

- (CPArray) pathsMatchingExtensions: (CPArray filterTypes

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:
filterTypesan array of CPString objects that contain file extensions (without the '.')
Returns:
a new array with matching paths

Definition at line 796 of file CPArray.j.

- (CPEnumerator) reverseObjectEnumerator

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 271 of file CPArray.j.

- (void) setValue: (id)  aValue
forKey: (CPString aKey 

Reimplemented from CPObject.

Definition at line 491 of file CPArray+KVO.j.

- (void) setValue: (id)  aValue
forKeyPath: (CPString aKeyPath 

Reimplemented from CPObject.

Definition at line 500 of file CPArray+KVO.j.

- (CPArray) sortedArrayUsingDescriptors: (CPArray descriptors

Definition at line 696 of file CPArray.j.

- (CPArray) sortedArrayUsingFunction: (Function)  aFunction

Return a copy of the receiver sorted using the function passed into the first parameter.

Definition at line 708 of file CPArray.j.

- (CPArray) sortedArrayUsingFunction: (Function)  aFunction
context: (id)  aContext 

Returns an array in which the objects are ordered according to a sort with aFunction. This invokes -sortUsingFunction:context.

Parameters:
aFunctiona JavaScript 'Function' type that compares objects
aContextcontext information
Returns:
a new sorted array

Definition at line 721 of file CPArray.j.

- (CPArray) sortedArrayUsingSelector: (SEL)  aSelector

Returns a new array in which the objects are ordered according to a sort with aSelector.

Parameters:
aSelectorthe selector that will perform object comparisons

Definition at line 734 of file CPArray.j.

- (CPArray) subarrayWithRange: (CPRange)  aRange

Returns a subarray of the receiver containing the objects found in the specified range aRange.

Parameters:
aRangethe range of objects to be copied into the subarray
Exceptions:
CPRangeExceptionif the specified range exceeds the bounds of the array

Definition at line 674 of file CPArray.j.

- (id) valueForKey: (CPString aKey

Reimplemented from CPObject.

Definition at line 418 of file CPArray+KVO.j.

- (id) valueForKeyPath: (CPString aKeyPath

Reimplemented from CPObject.

Definition at line 450 of file CPArray+KVO.j.


The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Defines