Standard class NSArray functionality extending category. More...

#import <NSArray+SCArray.h>

Inheritance diagram for NSArray(SCArray):

Creating Arrays
(instancetype)	+ arrayWithCoder:

(instancetype)	+ arrayWithContentsOfSerializedFile:

(instancetype)	+ arrayWithDataDictionary:

(instancetype)	+ arrayWithDataDictionaryFromFile:

(instancetype)	+ arrayWithStream:

(instancetype)	+ arrayWithFileStream:

(instancetype)	+ arrayWithData:

(instancetype)	+ arrayWithContentsOfURLString:

(instancetype)	+ arrayWithAscendingSortedCollection:sorter:

(instancetype)	+ arrayWithDescendingSortedCollection:sorter:

(instancetype)	+ arrayWithSortedCollection:sorter:

(instancetype)	+ arrayWithAscendingSortedCollection:

(instancetype)	+ arrayWithDescendingSortedCollection:

(instancetype)	+ arrayWithSortedCollection:

(instancetype)	+ arrayWithCollection:

Initializing Arrays
(instancetype)	- initWithAscendingSortedCollection:sorter:

(instancetype)	- initWithDescendingSortedCollection:sorter:

(instancetype)	- initWithSortedCollection:sorter:

(instancetype)	- initWithAscendingSortedCollection:

(instancetype)	- initWithDescendingSortedCollection:

(instancetype)	- initWithSortedCollection:

(instancetype)	- initWithCollection:

Protocol SCCollection Implementation
NSString *	name

BOOL	empty

BOOL	readOnly

id< SCCollectionDelegate >	delegate

SCCollectionType	collectionType

BOOL	isCollection

BOOL	isLibraryCollection

BOOL	isFoundationCollection

BOOL	isArray

BOOL	isLibraryArray

BOOL	isFoundationArray

BOOL	isSet

BOOL	isLibrarySet

BOOL	isFoundationSet

BOOL	isOrderedSet

BOOL	isLibraryOrderedSet

BOOL	isFoundationOrderedSet

BOOL	isDictionary

BOOL	isLibraryDictionary

BOOL	isFoundationDictionary

BOOL	isStack

BOOL	isQueue

BOOL	isList

BOOL	isSortable

Finding Objects in an Array
SCIndex	indexOfLastObject

(BOOL)	- containsObjects:

(BOOL)	- containsCollection:

(BOOL)	- containsAnyObject:

(BOOL)	- containsAnyObjectFromCollection:

Converting Arrays
SCArray *	array

SCSet *	set

SCOrderedSet *	orderedSet

SCDictionary *	dictionary

SCStack *	stack

SCQueue *	queue

SCUnidirectionalList *	unidirectionalList

SCBidirectionalList *	bidirectionalList

NSArray *	foundationArray

NSSet *	foundationSet

NSOrderedSet *	foundationOrderedSet

NSDictionary *	foundationDictionary

NSArray *	reversedArray

Sorting Arrays
NSArray *	ascendingSortedArray

NSArray *	descendingSortedArray

NSArray *	sortedArray

(NSArray *)	- ascendingSortedArrayWithSorter:

(NSArray *)	- descendingSortedArrayWithSorter:

(NSArray *)	- sortedArrayWithSorter:

Comparing Arrays
(BOOL)	- isEqualToCollection:

Deriving New Arrays
(NSArray *)	- arrayByAddingObjects:

(NSArray *)	- arrayByAddingArray:

(NSArray *)	- arrayByAddingCollection:

Additional Inherited Members
Instance Methods inherited from <SCCollection>
(NSUInteger)	- countByEnumeratingWithState:objects:count:

(BOOL)	- containsObject:

Instance Methods inherited from <SCIndexedCollection>
(id)	- objectAtIndex:

(id)	- objectAtIndexedSubscript:

(SCIndex)	- indexOfObject:

Properties inherited from <SCCollection>
NSString *	name

SCIndex	count

BOOL	empty

BOOL	readOnly

id< SCCollectionDelegate >	delegate

SCArray *	array

SCSet *	set

SCOrderedSet *	orderedSet

SCDictionary *	dictionary

SCStack *	stack

SCQueue *	queue

SCUnidirectionalList *	unidirectionalList

SCBidirectionalList *	bidirectionalList

NSArray *	foundationArray

NSSet *	foundationSet

NSOrderedSet *	foundationOrderedSet

NSDictionary *	foundationDictionary

NSEnumerator *	objectEnumerator

NSEnumerator *	reverseObjectEnumerator

SCCollectionType	collectionType

BOOL	isCollection

BOOL	isLibraryCollection

BOOL	isFoundationCollection

BOOL	isArray

BOOL	isLibraryArray

BOOL	isFoundationArray

BOOL	isSet

BOOL	isLibrarySet

BOOL	isFoundationSet

BOOL	isOrderedSet

BOOL	isLibraryOrderedSet

BOOL	isFoundationOrderedSet

BOOL	isDictionary

BOOL	isLibraryDictionary

BOOL	isFoundationDictionary

BOOL	isStack

BOOL	isQueue

BOOL	isList

BOOL	isSortable

Properties inherited from <SCIndexedCollection>
id	firstObject

id	lastObject

SCIndex	indexOfLastObject

Detailed Description

Standard class NSArray functionality extending category.

SDK: macOS 10.6+, iOS 7.0+, GNUstep

Since: version 1.1.3

Implements the additional methods for add into the standard class NSArray the enhanced functionality.

Method Documentation

- (NSArray *) arrayByAddingArray: (NSArray *) array

Returns a new array that is a copy of the receiving array with the objects contained in another array added to the end.

Parameters

array - the array with added objects

Returns: A new array with objects from the receiving array and objects from a given another array.

Since: version 1.2.3

- (NSArray *) arrayByAddingCollection: (id<SCCollection>) collection

Returns a new array that is a copy of the receiving array with the objects contained in the specified collection added to the end.

Parameters

collection - the collection with added objects

Returns: A new array with objects from the receiving array and objects from a given collection

Exceptions

SCCollectionException - collection error detected

Since: version 1.2.3

- (NSArray *) arrayByAddingObjects:	(id)	object
,		NS_REQUIRES_NIL_TERMINATION

Returns a new array that is a copy of the receiving array with the objects from the specified list added to the end.

Parameters

object	- the first object to add into the new array
...	- a comma-separated list of additional objects, ending with nil pointer
NS_REQUIRES_NIL_TERMINATION	- a mandatory nil pointer

Returns: A new array with objects from the receiving array and objects from the specified list

Since: version 1.2.3

+ (instancetype) arrayWithAscendingSortedCollection: (id<SCCollection>) collection

Returns an ascending sorted array created by using the specified existing collection of any supported type.

Parameters

collection - the source collection

Returns: A created array with the ascending sorted objects

Exceptions

SCCollectionException - collection error detected

See also: + arrayWithSortedCollection:

+ (instancetype) arrayWithAscendingSortedCollection:	(id<SCCollection>)	collection
sorter:	(id<SCSorter>)	sorter

Returns an ascending sorted array created by using the specified existing collection of any supported type and a given data sorter.

Parameters

collection	- the source collection
sorter	- the data sorter

Returns: A created array with the ascending sorted objects

Exceptions

SCCollectionException - collection error detected

See also: + arrayWithSortedCollection:sorter:

+ (instancetype) arrayWithCoder: (NSCoder *) coder

Returns an array created by using the specified coder.

Parameters

coder - the source coder

Returns: A created array

+ (instancetype) arrayWithCollection: (id<SCCollection>) collection

Returns an array created by using the specified existing collection of any supported type.

Parameters

collection - the source collection

Returns: A created array

Exceptions

SCCollectionException - collection error detected

+ (instancetype) arrayWithContentsOfSerializedFile: (NSString *) path

Returns an array created by using the content of serialized file with the specified path.

Parameters

path	- the path to the source serialized file

Returns: A created array

+ (instancetype) arrayWithContentsOfURLString: (NSString *) urlString

Returns an array created by using the data from the URL with the specified string.

Parameters

urlString - the string of the source URL

Returns: A created array

+ (instancetype) arrayWithData: (NSData *) data

Returns an array created by using the specified data object.

Parameters

data	- the source data object

Returns: A created array

+ (instancetype) arrayWithDataDictionary: (NSDictionary *) dictionary

Returns an array created by using the specified data dictionary.

Parameters

dictionary - the source data dictionary

Returns: A created array

+ (instancetype) arrayWithDataDictionaryFromFile: (NSString *) path

Returns an array created by using the data dictionary from the specified file.

Parameters

path	- the path to the source file with the data dictionary

Returns: A created array

+ (instancetype) arrayWithDescendingSortedCollection: (id<SCCollection>) collection

Returns a descending sorted array created by using the specified existing collection of any supported type.

Parameters

collection - the source collection

Returns: A created array with the descending sorted objects

Exceptions

SCCollectionException - collection error detected

+ (instancetype) arrayWithDescendingSortedCollection:	(id<SCCollection>)	collection
sorter:	(id<SCSorter>)	sorter

Returns a descending sorted array created by using the specified existing collection of any supported type and a given data sorter.

Parameters

collection	- the source collection
sorter	- the data sorter

Returns: A created array with the descending sorted objects

Exceptions

SCCollectionException - collection error detected

+ (instancetype) arrayWithFileStream: (NSString *) path

Returns an array created by using the data from the file stream with the specified path.

Parameters

path	- the path to the source file stream

Returns: A created array

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

+ (instancetype) arrayWithSortedCollection: (id<SCCollection>) collection

Returns an ascending sorted array created by using the specified existing collection of any supported type.

Parameters

collection - the source collection

Returns: A created array with the ascending sorted objects

Exceptions

SCCollectionException - collection error detected

See also: + arrayWithAscendingSortedCollection:

+ (instancetype) arrayWithSortedCollection:	(id<SCCollection>)	collection
sorter:	(id<SCSorter>)	sorter

Returns an ascending sorted array created by using the specified existing collection of any supported type and a given data sorter.

Parameters

collection	- the source collection
sorter	- the data sorter

Returns: A created array with the ascending sorted objects

Exceptions

SCCollectionException - collection error detected

See also: + arrayWithAscendingSortedCollection:sorter:

+ (instancetype) arrayWithStream: (SCStream *) stream

Returns an array created by using the data from the specified stream.

Parameters

stream - the source stream

Returns: A created array

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

- (NSArray *) ascendingSortedArrayWithSorter: (id<SCSorter>) sorter

Returns an array with objects from the receiving array that are ascending sorted by using the specified data sorter.

Parameters

sorter - the data sorter

Returns: An array with the sorted objects

Exceptions

SCCollectionException - collection error detected

See also: - sortedArrayWithSorter:

- (BOOL) containsAnyObject:	(id<SCCollectioning>)	object
,		NS_REQUIRES_NIL_TERMINATION

Returns a boolean value that indicates whether the receiving array contains at least one object from the specified list.

Parameters

object	- the first object to find within the receiving array
...	- a comma-separated list of additional objects, ending with nil pointer
NS_REQUIRES_NIL_TERMINATION	- a mandatory nil pointer

Returns: YES if the receiving array contains at least one object from the list, otherwise NO

Reimplemented from <SCCollection>.

- (BOOL) containsAnyObjectFromCollection: (id<SCCollection>) collection

Returns a boolean value that indicates whether the receiving array contains at least one object from the specified collection of any supported type.

Parameters

collection - the collection with the required objects

Returns: YES if the receiving array contains at least one object from the specified collection, otherwise NO

Reimplemented from <SCCollection>.

- (BOOL) containsCollection: (id<SCCollection>) collection

Returns a boolean value that indicates whether the receiving array contains all objects from the specified collection of any supported type.

Parameters

collection - the collection with the required objects

Returns: YES if the all required objects are present in the receiving array, otherwise NO

Reimplemented from <SCCollection>.

- (BOOL) containsObjects:	(id<SCCollectioning>)	object
,		NS_REQUIRES_NIL_TERMINATION

Returns a boolean value that indicates whether the receiving array contains all objects from the specified list.

Parameters

object	- the first object to find within the receiving array
...	- a comma-separated list of additional objects, ending with nil pointer
NS_REQUIRES_NIL_TERMINATION	- a mandatory nil pointer

Returns: YES if all objects are present in the receiving array, otherwise NO

Reimplemented from <SCCollection>.

- (NSArray *) descendingSortedArrayWithSorter: (id<SCSorter>) sorter

Returns an array with objects from the receiving array that are descending sorted by using the specified data sorter.

Parameters

sorter - the data sorter

Returns: An array with the sorted objects

Exceptions

SCCollectionException - collection error detected

- (instancetype) initWithAscendingSortedCollection: (id<SCCollection>) collection

Initializes an array using the ascending sorted content from the specified existing collection.

Parameters

collection - the source collection

Returns: A newly initialized array with the ascending sorted objects

Exceptions

SCCollectionException - collection error detected

See also: - initWithSortedCollection:

- (instancetype) initWithAscendingSortedCollection:	(id<SCCollection>)	collection
sorter:	(id<SCSorter>)	sorter

Initializes an array using the ascending sorted content from the specified existing collection and a given sorter.

Parameters

collection	- the source collection
sorter	- the data sorter

Returns: A newly initialized array with the ascending sorted objects

Exceptions

SCCollectionException - collection error detected

See also: - initWithSortedCollection:sorter:

- (instancetype) initWithCollection: (id<SCCollection>) collection

Initializes an array using the specified existing collection of any supported type.

Parameters

collection - the source collection

Returns: A newly initialized array

Exceptions

SCCollectionException - collection error detected

Reimplemented from <SCCollection>.

- (instancetype) initWithDescendingSortedCollection: (id<SCCollection>) collection

Initializes an array using the descending sorted content from the specified existing collection.

Parameters

collection - the source collection

Returns: A newly initialized array with the descending sorted objects

Exceptions

SCCollectionException - collection error detected

- (instancetype) initWithDescendingSortedCollection:	(id<SCCollection>)	collection
sorter:	(id<SCSorter>)	sorter

Initializes an array using the descending sorted content from the specified existing collection and a given sorter.

Parameters

collection	- the source collection
sorter	- the data sorter

Returns: A newly initialized array with the descending sorted objects

Exceptions

SCCollectionException - collection error detected

- (instancetype) initWithSortedCollection: (id<SCCollection>) collection

Initializes an array using the ascending sorted content from the specified existing collection.

Parameters

collection - the source collection

Returns: A newly initialized array with the ascending sorted objects

Exceptions

SCCollectionException - collection error detected

See also: - initWithAscendingSortedCollection:

- (instancetype) initWithSortedCollection:	(id<SCCollection>)	collection
sorter:	(id<SCSorter>)	sorter

Initializes an array using the ascending sorted content from the specified existing collection and a given sorter.

Parameters

collection	- the source collection
sorter	- the data sorter

Returns: A newly initialized array with the ascending sorted objects

Exceptions

SCCollectionException - collection error detected

See also: - initWithAscendingSortedCollection:sorter:

- (BOOL) isEqualToCollection: (id<SCCollection>) collection

Compares the receiving array to the specified collection of any supported type.

Parameters

collection - a collection

Returns: YES if the contents of the specified collection are equal to the contents of the receiving array, otherwise NO

Exceptions

SCCollectionException - collection error detected

Reimplemented from <SCCollection>.

- (NSArray *) sortedArrayWithSorter: (id<SCSorter>) sorter

Returns an array with objects from the receiving array that are ascending sorted by using the specified data sorter.

Parameters

sorter - the data sorter

Returns: An array with the sorted objects

Exceptions

SCCollectionException - collection error detected

See also: - ascendingSortedArrayWithSorter:

Property Documentation

- (SCArray *) array

readnonatomicassign

An array with the all objects from the receiving array

- (NSArray *) ascendingSortedArray

readnonatomicassign

An array with the ascending sorted objects

See also: sortedArray

- (SCBidirectionalList *) bidirectionalList

readnonatomicassign

A bidirectional list with the all objects from the receiving array

- (SCCollectionType) collectionType

readnonatomicassign

A type of the collection

- (id) delegate

readnonatomicretain

Array delegate object

- (NSArray *) descendingSortedArray

readnonatomicassign

An array with the descending sorted objects

- (SCDictionary *) dictionary

readnonatomicassign

A dictionary with the all objects from the receiving array

- (BOOL) empty

readnonatomicassign

Determines whether the array is empty or contains at least one object

- (NSArray *) foundationArray

readnonatomicassign

A foundation array with the all objects from the receiving array

- (NSDictionary *) foundationDictionary

readnonatomicassign

A foundation dictionary with all objects from the receiving array

- (NSOrderedSet *) foundationOrderedSet

readnonatomicassign

A foundation ordered set with the all objects from the receiving array

- (NSSet *) foundationSet

readnonatomicassign

A foundation set with the all objects from the receiving array

- (SCIndex) indexOfLastObject

readnonatomicassign

An index of the last object within the array

- (BOOL) isArray

readnonatomicassign

A boolean value that indicates whether a receiving instance is an array of any supported type

- (BOOL) isCollection

readnonatomicassign

A boolean value that indicates whether a receiving instance is a collection of any supported type

- (BOOL) isDictionary

readnonatomicassign

A boolean value that indicates whether a receiving instance is a dictionary of any supported type

- (BOOL) isFoundationArray

readnonatomicassign

A boolean value that indicates whether a receiving instance is a standard array (instances of the classes NSArray and NSMutableArray)

- (BOOL) isFoundationCollection

readnonatomicassign

A boolean value that indicates whether a receiving instance is a standard Objective-C collection

- (BOOL) isFoundationDictionary

readnonatomicassign

A boolean value that indicates whether a receiving instance is a standard dictionary (instances of the classes NSDictionary and NSMutableDictionary)

- (BOOL) isFoundationOrderedSet

readnonatomicassign

A boolean value that indicates whether a receiving instance is a standard orderde set (instances of the classes NSOrderedSet and NSMutableOrderedSet)

- (BOOL) isFoundationSet

readnonatomicassign

A boolean value that indicates whether a receiving instance is a standard set (instances of the classes NSSet and NSMutableSet)

- (BOOL) isLibraryArray

readnonatomicassign

A boolean value that indicates whether a receiving instance is a library array (class SCArray instance)

- (BOOL) isLibraryCollection

readnonatomicassign

A boolean value that indicates whether a receiving instance is a library collection

- (BOOL) isLibraryDictionary

readnonatomicassign

A boolean value that indicates whether a receiving instance is a library dictionary (class SCDictionary instance)

- (BOOL) isLibraryOrderedSet

readnonatomicassign

A boolean value that indicates whether a receiving instance is a library ordered set (class SCOrderedSet instance)

- (BOOL) isLibrarySet

readnonatomicassign

A boolean value that indicates whether a receiving instance is a library set (class SCSet instance)

- (BOOL) isList

readnonatomicassign

A boolean value that indicates whether a receiving instance is a list (instances of the classes SCUnidirectionalList and SCBidirectionalList)

- (BOOL) isOrderedSet

readnonatomicassign

A boolean value that indicates whether a receiving instance is an ordered set of any supported type

- (BOOL) isQueue

readnonatomicassign

A boolean value that indicates whether a receiving instance is a queue (class SCQueue instance)

- (BOOL) isSet

readnonatomicassign

A boolean value that indicates whether a receiving instance is a set of any supported type

- (BOOL) isSortable

readnonatomicassign

A boolean value that indicates whether a receiving instance is a sortable collection (array or ordered set of any supported type)

- (BOOL) isStack

readnonatomicassign

A boolean value that indicates whether a receiving instance is a stack (class SCStack instance)

- (NSString *) name

readnonatomicretain

Name of the array

- (SCOrderedSet *) orderedSet

readnonatomicassign

An ordered set with the all objects from the receiving array

- (SCQueue *) queue

readnonatomicassign

A queue with the all objects from the receiving array

- (BOOL) readOnly

readnonatomicassign

Determines whether the array is in read only mode

- (NSArray *) reversedArray

readnonatomicassign

An array with objects in the reversed order

- (SCSet *) set

readnonatomicassign

A set with the all objects from the receiving array

- (NSArray *) sortedArray

readnonatomicassign

An array with the ascending sorted objects

See also: ascendingSortedArray

- (SCStack *) stack

readnonatomicassign

A stack with the all objects from the receiving array

- (SCUnidirectionalList *) unidirectionalList

readnonatomicassign

An unidirectional list with the all objects from the receiving array

The documentation for this category was generated from the following files:

NSArray+SCArray.h
NSArray+SCArray.m

Creating Arrays

Initializing Arrays

Protocol SCCollection Implementation

Finding Objects in an Array

Converting Arrays

Sorting Arrays

Comparing Arrays

Deriving New Arrays

Additional Inherited Members

Detailed Description

Method Documentation

Property Documentation