SCArray Class Reference

Array class. More...

#import <SCArray.h>

Inheritance diagram for SCArray:

Creating Arrays
(SCArray *)	+ arrayWithCoder:
(SCArray *)	+ arrayWithContentsOfSerializedFile:
(SCArray *)	+ arrayWithDataDictionary:
(SCArray *)	+ arrayWithDataDictionaryFromFile:
(SCArray *)	+ arrayWithStream:
(SCArray *)	+ arrayWithFileStream:
(SCArray *)	+ arrayWithName:
(SCArray *)	+ arrayWithObject:
(SCArray *)	+ arrayWithObjects:
(SCArray *)	+ arrayWithCollection:
(SCArray *)	+ arrayWithArray:
(SCArray *)	+ array
(SCArray *)	+ arrayWithAscendingSortedCollection:sorter:
(SCArray *)	+ arrayWithDescendingSortedCollection:sorter:
(SCArray *)	+ arrayWithSortedCollection:sorter:
(SCArray *)	+ arrayWithAscendingSortedCollection:
(SCArray *)	+ arrayWithDescendingSortedCollection:
(SCArray *)	+ arrayWithSortedCollection:

Initializing Arrays
(id)	- initWithName:
(id)	- initWithObject:
(id)	- initWithObjects:
(id)	- initWithCollection:
(id)	- initWithArray:
(id)	- init
(id)	- initWithAscendingSortedCollection:sorter:
(id)	- initWithDescendingSortedCollection:sorter:
(id)	- initWithSortedCollection:sorter:
(id)	- initWithAscendingSortedCollection:
(id)	- initWithDescendingSortedCollection:
(id)	- initWithSortedCollection:

Copying Arrays
(void)	- setArray:
(void)	- setAscendingSortedCollection:sorter:
(void)	- setDescendingSortedCollection:sorter:
(void)	- setSortedCollection:sorter:
(void)	- setAscendingSortedCollection:
(void)	- setDescendingSortedCollection:
(void)	- setSortedCollection:

Comparing Arrays
(BOOL)	- isEqualToArray:
(BOOL)	- isEqualToContentsOfArray:

Sorting Arrays
SCArray *	sortedArray
(void)	- sortAscendingWithSorter:
(void)	- sortDescendingWithSorter:
(void)	- sortWithSorter:
(void)	- sortAscending
(void)	- sortDescending
(void)	- sort
(SCArray *)	- ascendingSortedArrayWithSorter:
(SCArray *)	- descendingSortedArrayWithSorter:
(SCArray *)	- sortedArrayWithSorter:
(SCArray *)	- ascendingSortedArray
(SCArray *)	- descendingSortedArray

Adding Objects
(void)	- insertObject:atIndex:
(void)	- insertByte:atIndex:
(void)	- insertUByte:atIndex:
(void)	- insertShort:atIndex:
(void)	- insertUShort:atIndex:
(void)	- insertInteger:atIndex:
(void)	- insertUInteger:atIndex:
(void)	- insertLong:atIndex:
(void)	- insertULong:atIndex:
(void)	- insertChar:atIndex:
(void)	- insertUnichar:atIndex:
(void)	- insertCharString:atIndex:
(void)	- insertBool:atIndex:
(void)	- insertFloat:atIndex:
(void)	- insertDouble:atIndex:
(void)	- setObject:atIndex:
(void)	- setByte:atIndex:
(void)	- setUByte:atIndex:
(void)	- setShort:atIndex:
(void)	- setUShort:atIndex:
(void)	- setInteger:atIndex:
(void)	- setUInteger:atIndex:
(void)	- setLong:atIndex:
(void)	- setULong:atIndex:
(void)	- setChar:atIndex:
(void)	- setUnichar:atIndex:
(void)	- setCharString:atIndex:
(void)	- setBool:atIndex:
(void)	- setFloat:atIndex:
(void)	- setDouble:atIndex:
(void)	- insertAtIndex:objects:
(void)	- insertCollection:atIndex:
(void)	- insertAtIndexes:objects:
(void)	- insertCollection:atIndexes:

Removing Objects
(void)	- removeFirstObject
(void)	- removeLastObject
(void)	- removeObjectAtIndex:
(void)	- removeObjectsAtIndexes:
(void)	- removeObjectsInRange:

Replacing Objects
(void)	- replaceObjectAtIndex:withObject:
(void)	- replaceObjectAtIndex:withByte:
(void)	- replaceObjectAtIndex:withUByte:
(void)	- replaceObjectAtIndex:withShort:
(void)	- replaceObjectAtIndex:withUShort:
(void)	- replaceObjectAtIndex:withInteger:
(void)	- replaceObjectAtIndex:withUInteger:
(void)	- replaceObjectAtIndex:withLong:
(void)	- replaceObjectAtIndex:withULong:
(void)	- replaceObjectAtIndex:withChar:
(void)	- replaceObjectAtIndex:withUnichar:
(void)	- replaceObjectAtIndex:withCharString:
(void)	- replaceObjectAtIndex:withBool:
(void)	- replaceObjectAtIndex:withFloat:
(void)	- replaceObjectAtIndex:withDouble:
(void)	- replaceObjectsAtIndexes:withObjects:
(void)	- replaceObjectsAtIndexes:withCollection:
(void)	- replaceObjectsInRange:withObjects:
(void)	- replaceObjectsInRange:withCollection:

Copying and Moving Objects
SCArray *	reversedArray
(void)	- exchangeObjectAtIndex:withObjectAtIndex:
(void)	- duplicateObjectAtIndex:
(void)	- duplicateObjectsInRange:
(void)	- duplicateAllObjects
(void)	- duplicate
(void)	- copyObjectAtIndex:toIndex:
(void)	- copyObjectsInRange:toIndex:
(void)	- moveObjectAtIndex:toIndex:
(void)	- moveObjectsInRange:toIndex:
(void)	- reverse

Querying an Array
id	firstObject
NSString *	firstString
NSNumber *	firstNumber
id	lastObject
NSString *	lastString
NSNumber *	lastNumber
(id)	- objectAtIndex:
(NSString *)	- stringAtIndex:
(NSNumber *)	- numberAtIndex:
(SCArray *)	- objectsAtIndexes:
(SCArray *)	- objectsInRange:

Finding Objects in an Array
SCIndex	indexOfLastObject
(SCIndex)	- indexOfObject:
(SCIndex)	- indexOfByte:
(SCIndex)	- indexOfUByte:
(SCIndex)	- indexOfShort:
(SCIndex)	- indexOfUShort:
(SCIndex)	- indexOfInteger:
(SCIndex)	- indexOfUInteger:
(SCIndex)	- indexOfLong:
(SCIndex)	- indexOfULong:
(SCIndex)	- indexOfChar:
(SCIndex)	- indexOfUnichar:
(SCIndex)	- indexOfCharString:
(SCIndex)	- indexOfBool:
(SCIndex)	- indexOfFloat:
(SCIndex)	- indexOfDouble:
(SCIndex)	- indexOfObject:inRange:
(SCIndex)	- indexOfByte:inRange:
(SCIndex)	- indexOfUByte:inRange:
(SCIndex)	- indexOfShort:inRange:
(SCIndex)	- indexOfUShort:inRange:
(SCIndex)	- indexOfInteger:inRange:
(SCIndex)	- indexOfUInteger:inRange:
(SCIndex)	- indexOfLong:inRange:
(SCIndex)	- indexOfULong:inRange:
(SCIndex)	- indexOfChar:inRange:
(SCIndex)	- indexOfUnichar:inRange:
(SCIndex)	- indexOfCharString:inRange:
(SCIndex)	- indexOfBool:inRange:
(SCIndex)	- indexOfFloat:inRange:
(SCIndex)	- indexOfDouble:inRange:

Additional Inherited Members
Instance Methods inherited from SCCollection
(void)	- enumerateWithDelegate:
(void)	- enumerate
(void)	- reverseEnumerateWithDelegate:
(void)	- reverseEnumerate
(void)	- setCollection:
(void)	- setObject:
(void)	- setObjects:
(BOOL)	- isEqualToCollection:
(BOOL)	- isEqual:
(void)	- addObjects:
(void)	- addByte:
(void)	- addUByte:
(void)	- addShort:
(void)	- addUShort:
(void)	- addInteger:
(void)	- addUInteger:
(void)	- addLong:
(void)	- addULong:
(void)	- addChar:
(void)	- addUnichar:
(void)	- addCharString:
(void)	- addBool:
(void)	- addFloat:
(void)	- addDouble:
(void)	- addCollection:
(void)	- removeObjectsWithClassName:
(void)	- removeCollection:
(void)	- removeByte:
(void)	- removeUByte:
(void)	- removeShort:
(void)	- removeUShort:
(void)	- removeInteger:
(void)	- removeUInteger:
(void)	- removeLong:
(void)	- removeULong:
(void)	- removeChar:
(void)	- removeUnichar:
(void)	- removeCharString:
(void)	- removeBool:
(void)	- removeFloat:
(void)	- removeDouble:
(void)	- removeObjects:
(BOOL)	- containsByte:
(BOOL)	- containsUByte:
(BOOL)	- containsShort:
(BOOL)	- containsUShort:
(BOOL)	- containsInteger:
(BOOL)	- containsUInteger:
(BOOL)	- containsLong:
(BOOL)	- containsULong:
(BOOL)	- containsChar:
(BOOL)	- containsUnichar:
(BOOL)	- containsCharString:
(BOOL)	- containsBool:
(BOOL)	- containsFloat:
(BOOL)	- containsDouble:
(BOOL)	- containsObjects:
(BOOL)	- containsCollection:
(BOOL)	- containsAnyObject:
(BOOL)	- containsAnyObjectFromCollection:
(BOOL)	- isCollection
(BOOL)	- isLibraryCollection
(BOOL)	- isFoundationCollection
(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
Instance Methods inherited from SCObject
(id)	- initWithContentsOfSerializedFile:
(BOOL)	- writeContentsToSerializedFile:
(id)	- initWithDataDictionaryFromFile:
(void)	- writeToDataDictionaryFile:atomically:
(void)	- writeToDataDictionaryFile:
(NSDictionary *)	- dataDictionary
(id)	- initWithFileStream:
(void)	- writeToFileStream:
(void)	- appendToFileStream:
Instance Methods inherited from <SCCoding>
Instance Methods inherited from <SCDictionaring>
Instance Methods inherited from <SCCollectioning>
Instance Methods inherited from <SCMutableCollection>
Instance Methods inherited from <SCCollection>
Instance Methods inherited from <SCIndexedCollection>
Instance Methods inherited from <SCMutableIndexedCollection>
Class Methods inherited from SCCollection
(BOOL)	+ isCollectionClass:
(BOOL)	+ isLibraryCollectionClass:
(BOOL)	+ isFoundationCollectionClass:
(BOOL)	+ isArrayClass:
(BOOL)	+ isLibraryArrayClass:
(BOOL)	+ isFoundationArrayClass:
(BOOL)	+ isSetClass:
(BOOL)	+ isLibrarySetClass:
(BOOL)	+ isFoundationSetClass:
(BOOL)	+ isOrderedSetClass:
(BOOL)	+ isLibraryOrderedSetClass:
(BOOL)	+ isFoundationOrderedSetClass:
(BOOL)	+ isDictionaryClass:
(BOOL)	+ isLibraryDictionaryClass:
(BOOL)	+ isFoundationDictionaryClass:
(BOOL)	+ isStackClass:
(BOOL)	+ isQueueClass:
(BOOL)	+ isListClass:
(BOOL)	+ isSortableClass:
(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 SCCollection
NSString *	name
BOOL	readOnly
id< SCCollectionDelegate >	delegate
SCULong	count
BOOL	empty
NSString *	typeName
NSString *	description
NSEnumerator *	objectEnumerator
NSEnumerator *	reverseObjectEnumerator
Properties inherited from <SCCollection>
SCULong	count
BOOL	empty
NSString *	description
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

Detailed Description

Array class.

Since

version 1.1.3

Implements the array, which is a collection with the indexed access to the objects.
Class instances can thrown the following exceptions:

• SCL-20041: source collection does not exist
• SCL-20042: unsupported collection type
• SCL-20043: collection is read-only
• SCL-20044: adding a null pointer
• SCL-20045: source object does not exist
• SCL-20046: unsupported class
• SCL-20047: unknown class
• SCL-20048: incomparable collection object
• SCL-20050: incorrect data sorter
• SCL-20051: unexpected class
• SCL-20052: incorrect index
• SCL-20053: incorrect objects range
• SCL-20054: incorrect index set
• SCL-20055: number of indexes does not match number of objects

Method Documentation

+ (SCArray *) array

Returns an empty unnamed array created by using the default settings.

Returns

A created array

Reimplemented from SCCollection.

+ (SCArray *) arrayWithArray:

(SCArray *)

array

Returns an array created by using the specified existing array.

Parameters

array

- existing source array

Returns

A created array

Exceptions

SCCollectionException

- collection error detected

+ (SCArray *) arrayWithAscendingSortedCollection:

(id)

collection

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

Parameters

collection

- existing source collection

Returns

A created array with the ascending sorted objects

Exceptions

SCCollectionException

- collection error detected

See also

+ arrayWithSortedCollection:

+ (SCArray *) arrayWithAscendingSortedCollection:		(id)	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	- existing source collection
sorter	- data sorter

Returns

A created array with the ascending sorted objects

Exceptions

SCCollectionException

- collection error detected

See also

+ arrayWithSortedCollection:sorter:

+ (SCArray *) arrayWithCoder:

(NSCoder *)

coder

Returns an array created by using the specified coder.

Parameters

coder

- source coder

Returns

A created array

+ (SCArray *) arrayWithCollection:

(id)

collection

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

Parameters

collection

- existing source collection

Returns

A created array

Exceptions

SCCollectionException

- collection error detected

+ (SCArray *) arrayWithContentsOfSerializedFile:

(NSString *)

path

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

Parameters

path	- source serialized file path

Returns

A created array

+ (SCArray *) arrayWithDataDictionary:

(NSDictionary *)

dictionary

Returns an array created by using the specified data dictionary.

Parameters

dictionary

- source data dictionary

Returns

A created array

+ (SCArray *) arrayWithDataDictionaryFromFile:

(NSString *)

path

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

Parameters

path	- source data dictionary file path

Returns

A created array

+ (SCArray *) arrayWithDescendingSortedCollection:

(id)

collection

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

Parameters

collection

- existing source collection

Returns

A created array with the descending sorted objects

Exceptions

SCCollectionException

- collection error detected

+ (SCArray *) arrayWithDescendingSortedCollection:		(id)	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	- existing source collection
sorter	- data sorter

Returns

A created array with the descending sorted objects

Exceptions

SCCollectionException

- collection error detected

+ (SCArray *) arrayWithFileStream:

(NSString *)

path

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

Parameters

path	- path of the source file stream

Returns

A created array

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

+ (SCArray *) arrayWithName:

(NSString *)

name

Returns an empty array created by using the specified array name.

Parameters

name	- array name

Returns

A created array

+ (SCArray *) arrayWithObject:

(id)

object

Returns an array created by using the specified existing object.

Parameters

object

- existing source object

Returns

A created array

Exceptions

SCCollectionException

- collection error detected

+ (SCArray *) arrayWithObjects:		(id)	object
,			NS_REQUIRES_NIL_TERMINATION

Returns an array created by using objects from the specified nil terminated list.

Parameters

object	- first object
...	- other objects
NS_REQUIRES_NIL_TERMINATION	- mandatory nil pointer

Returns

A created array

+ (SCArray *) arrayWithSortedCollection:

(id)

collection

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

Parameters

collection

- existing source collection

Returns

A created array with the ascending sorted objects

Exceptions

SCCollectionException

- collection error detected

See also

+ arrayWithAscendingSortedCollection:

+ (SCArray *) arrayWithSortedCollection:		(id)	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	- existing source collection
sorter	- data sorter

Returns

A created array with the ascending sorted objects

Exceptions

SCCollectionException

- collection error detected

See also

+ arrayWithAscendingSortedCollection:sorter:

+ (SCArray *) arrayWithStream:

(SCStream *)

stream

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

Parameters

stream

- source stream

Returns

A created array

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

- (SCArray *) ascendingSortedArray

Returns an array with ascending sorted objects from the receiving array.

Returns

Array with sorted objects

Exceptions

SCCollectionException

- collection error detected

See also

Property sortedArray

- (SCArray *) 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

- data sorter

Returns

Array with sorted objects

Exceptions

SCCollectionException

- collection error detected

See also

- sortedArrayWithSorter:

- (void) copyObjectAtIndex:		(SCIndex)	index
toIndex:		(SCIndex)	destination

Copies the object at the specified source index to a given destination index.

Parameters

index	- source index of the object to be copied
destination	- destination index

Exceptions

SCCollectionException

- collection error detected

- (void) copyObjectsInRange:		(NSRange)	range
toIndex:		(SCIndex)	destination

Copies the objects in the specified range to a given destination index.

Parameters

range	- range of the objects to be copied
destination	- destination index

Exceptions

SCCollectionException

- collection error detected

- (SCArray *) descendingSortedArray

Returns an array with descending sorted objects from the receiving array.

Returns

Array with sorted objects

Exceptions

SCCollectionException

- collection error detected

- (SCArray *) 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

- data sorter

Returns

Array with sorted objects

Exceptions

SCCollectionException

- collection error detected

- (void) duplicate

Duplicates the content of the receiving array.

Exceptions

SCCollectionException

- collection error detected

- (void) duplicateAllObjects

Duplicates the all objects within the receiving array.

Exceptions

SCCollectionException

- collection error detected

- (void) duplicateObjectAtIndex:

(SCIndex)

index

Duplicates the object at the specified index.

Parameters

index

- index of the object to be duplicate

Exceptions

SCCollectionException

- collection error detected

- (void) duplicateObjectsInRange:

(NSRange)

range

Duplicates the objects within the specified range.

Parameters

range

- range of the objects to be duplicate

Exceptions

SCCollectionException

- collection error detected

- (void) exchangeObjectAtIndex:		(SCIndex)	index
withObjectAtIndex:		(SCIndex)	destination

Exchanges the objects in the receiving array at given indexes.

Parameters

index	- index of the first object
destination	- index of the second object

Exceptions

SCCollectionException

- collection error detected

- (SCIndex) indexOfBool:

(BOOL)

value

Returns the lowest index whose corresponding receiving array object is equal to a given boolean value.

Parameters

value

- desired value

Returns

Lowest index of the object that equals to the specified value, otherwise NO

- (SCIndex) indexOfBool:		(BOOL)	value
inRange:		(NSRange)	range

Returns the lowest index within a specified range whose corresponding receiving array object is equal to a given boolean value.

Parameters

value	- desired value
range	- range of indexes in the array whithin which to search for the specified value

Returns

Lowest index within range of the object that equals to the specified value, otherwise NO

Exceptions

SCCollectionException

- collection error detected

- (SCIndex) indexOfByte:

(SCByte)

value

Returns the lowest index whose corresponding receiving array object is equal to a given signed 8-bit integer value.

Parameters

value

- desired value

Returns

Lowest index of object that queals to the specified value, otherwise SCNotFound

- (SCIndex) indexOfByte:		(SCByte)	value
inRange:		(NSRange)	range

Returns the lowest index within a specified range whose corresponding receiving array object is equal to a given signed 8-bit integer value.

Parameters

value	- desired value
range	- range of indexes in the array within which to search for the specified value

Returns

Lowest index within range of the object that equals to the specified value, otherwise NO

Exceptions

SCCollectionException

- collection error detected

- (SCIndex) indexOfChar:

(char)

value

Returns the lowest index whose corresponding receiving array object is equal to a given character.

Parameters

value

- desired character

Returns

Lowest index of the object that equals to the specified character, otherwise SCNotFound

See also

- indexOfUnichar:

- (SCIndex) indexOfChar:		(char)	value
inRange:		(NSRange)	range

Returns the lowest index within a specified range whose corresponding receiving array object is equal to a given character.

Parameters

value	- desired character
range	- range of indexes in the array whithin which to search for the specified character

Returns

Lowest index within range of the object that equals to the specified character, otherwise NO

Exceptions

SCCollectionException

- collection error detected

See also

- indexOfUnichar:inRange:

- (SCIndex) indexOfCharString:

(const char *)

string

Returns the lowest index whose corresponding receiving array object is equal to a given character string.

Parameters

string

- desired string

Returns

Lowest index of the object that equals to the specified character string, otherwise SCNotFound

- (SCIndex) indexOfCharString:		(const char *)	string
inRange:		(NSRange)	range

Returns the lowest index within a specified range whose corresponding receiving array object is equal to a given character string.

Parameters

string	- desired character string
range	- range of indexes in the array whithin which to search for the specified character string

Returns

Lowest index within range of the object that equals to the specified character string, otherwise NO

Exceptions

SCCollectionException

- collection error detected

- (SCIndex) indexOfDouble:

(SCDouble)

value

Returns the lowest index whose corresponding receiving array object is equal to a given double value.

Parameters

value

- desired value

Returns

Lowest index of the object that equals to the specified value, otherwise NO

- (SCIndex) indexOfDouble:		(SCDouble)	value
inRange:		(NSRange)	range

Returns the lowest index within a specified range whose corresponding receiving array object is equal to a given double value.

Parameters

value	- desired value
range	- range of indexes in the array whithin which to search for the specified value

Returns

Lowest index within range of the object that equals to the specified value, otherwise NO

Exceptions

SCCollectionException

- collection error detected

- (SCIndex) indexOfFloat:

(SCFloat)

value

Returns the lowest index whose corresponding receiving array object is equal to a given float value.

Parameters

value

- desired value

Returns

Lowest index of the object that equals to the specified value, otherwise NO

- (SCIndex) indexOfFloat:		(SCFloat)	value
inRange:		(NSRange)	range

Returns the lowest index within a specified range whose corresponding receiving array object is equal to a given float value.

Parameters

value	- desired value
range	- range of indexes in the array whithin which to search for the specified value

Returns

Lowest index within range of the object that equals to the specified value, otherwise NO

Exceptions

SCCollectionException

- collection error detected

- (SCIndex) indexOfInteger:

(SCInteger)

value

Returns the lowest index whose corresponding receiving array object is equal to a given signed 32-bit integer value.

Parameters

value

- desired value

Returns

Lowest index of object that queals to the specified value, otherwise SCNotFound

- (SCIndex) indexOfInteger:		(SCInteger)	value
inRange:		(NSRange)	range

Returns the lowest index within a specified range whose corresponding receiving array object is equal to a given signed 32-bit integer value.

Parameters

value	- desired value
range	- range of indexes in the array whithin which to search for the specified value

Returns

Lowest index within range of the object that equals to the specified value, otherwise NO

Exceptions

SCCollectionException

- collection error detected

- (SCIndex) indexOfLong:

(SCLong)

value

Returns the lowest index whose corresponding receiving array object is equal to a given signed 64-bit integer value.

Parameters

value

- desired value

Returns

Lowest index of object that queals to the specified value, otherwise SCNotFound

- (SCIndex) indexOfLong:		(SCLong)	value
inRange:		(NSRange)	range

Returns the lowest index within a specified range whose corresponding receiving array object is equal to a given signed 64-bit integer value.

Parameters

value	- desired value
range	- range of indexes in the array whithin which to search for the specified value

Returns

Lowest index within range of the object that equals to the specified value, otherwise NO

Exceptions

SCCollectionException

- collection error detected

- (SCIndex) indexOfObject:

(id)

object

Returns the lowest index whose corresponding receiving array object is equal to a given object.

Parameters

object

- desired object

Returns

Lowest index of object that equals to the specified object, otherwise SCNotFound

Reimplemented from <SCIndexedCollection>.

- (SCIndex) indexOfObject:		(id)	object
inRange:		(NSRange)	range

Returns the lowest index within a specified range whose corresponding receiving array object is equal to a given object.

Parameters

object	- desired object
range	- range of indexes in the array within which to search for the specified object

Returns

Lowest index within range of the object that equals to the specified object, otherwise NO

Exceptions

SCCollectionException

- collection error detected

- (SCIndex) indexOfShort:

(SCShort)

value

Returns the lowest index whose corresponding receiving array object is equal to a given signed 16-bit integer value.

Parameters

value

- desired value

Returns

Lowest index of object that queals to the specified value, otherwise SCNotFound

- (SCIndex) indexOfShort:		(SCShort)	value
inRange:		(NSRange)	range

Returns the lowest index within a specified range whose corresponding receiving array object is equal to a given signed 16-bit integer value.

Parameters

value	- desired value
range	- range of indexes in the array whithin which to search for the specified value

Returns

Lowest index within range of the object that equals to the specified value, otherwise NO

Exceptions

SCCollectionException

- collection error detected

- (SCIndex) indexOfUByte:

(SCUByte)

value

Returns the lowest index whose corresponding receiving array object is equal to a given unsigned 8-bit integer value.

Parameters

value

- desired value

Returns

Lowest index of object that queals to the specified value, otherwise SCNotFound

- (SCIndex) indexOfUByte:		(SCUByte)	value
inRange:		(NSRange)	range

Returns the lowest index within a specified range whose corresponding receiving array object is equal to a given unsigned 8-bit integer value.

Parameters

value	- desired value
range	- range of indexes in the array within which to search for the specified value

Returns

Lowest index within range of the object that equals to the specified value, otherwise NO

Exceptions

SCCollectionException

- collection error detected

- (SCIndex) indexOfUInteger:

(SCUInteger)

value

Returns the lowest index whose corresponding receiving array object is equal to a given unsigned 32-bit integer value.

Parameters

value

- desired value

Returns

Lowest index of object that queals to the specified value, otherwise SCNotFound

- (SCIndex) indexOfUInteger:		(SCUInteger)	value
inRange:		(NSRange)	range

Returns the lowest index within a specified range whose corresponding receiving array object is equal to a given unsigned 32-bit integer value.

Parameters

value	- desired value
range	- range of indexes in the array whithin which to search for the specified value

Returns

Lowest index within range of the object that equals to the specified value, otherwise NO

Exceptions

SCCollectionException

- collection error detected

- (SCIndex) indexOfULong:

(SCULong)

value

Returns the lowest index whose corresponding receiving array object is equal to a given unsigned 64-bit integer value.

Parameters

value

- desired value

Returns

Lowest index of object that queals to the specified value, otherwise SCNotFound

- (SCIndex) indexOfULong:		(SCULong)	value
inRange:		(NSRange)	range

Returns the lowest index within a specified range whose corresponding receiving array object is equal to a given unsigned 64-bit integer value.

Parameters

value	- desired value
range	- range of indexes in the array whithin which to search for the specified value

Returns

Lowest index within range of the object that equals to the specified value, otherwise NO

Exceptions

SCCollectionException

- collection error detected

- (SCIndex) indexOfUnichar:

(unichar)

value

Returns the lowest index whose corresponding receiving array object is equal to a given character.

Parameters

value

- desired character

Returns

Lowest index of the object that equals to the specified character, otherwise SCNotFound

See also

- indexOfChar:

- (SCIndex) indexOfUnichar:		(unichar)	value
inRange:		(NSRange)	range

Returns the lowest index within a specified range whose corresponding receiving array object is equal to a given character.

Parameters

value	- desired character
range	- range of indexes in the array whithin which to search for the specified character

Returns

Lowest index within range of the object that equals to the specified character, otherwise NO

Exceptions

SCCollectionException

- collection error detected

See also

- indexOfChar:inRange:

- (SCIndex) indexOfUShort:

(SCUShort)

value

Returns the lowest index whose corresponding receiving array object is equal to a given unsigned 16-bit integer value.

Parameters

value

- desired value

Returns

Lowest index of object that queals to the specified value, otherwise SCNotFound

- (SCIndex) indexOfUShort:		(SCUShort)	value
inRange:		(NSRange)	range

Returns the lowest index within a specified range whose corresponding receiving array object is equal to a given unsigned 16-bit integer value.

Parameters

value	- desired value
range	- range of indexes in the array whithin which to search for the specified value

Returns

Lowest index within range of the object that equals to the specified value, otherwise NO

Exceptions

SCCollectionException

- collection error detected

- (id) init

Initializes an empty unnamed array using the default settings.

Returns

A newly initialized array

- (id) initWithArray:

(SCArray *)

array

Initializes an array using the specified existing array.

Attention

Designed initializer

Parameters

array

- existing source array

Returns

A newly initialized array

Exceptions

SCCollectionException

- collection error detected

- (id) initWithAscendingSortedCollection:

(id)

collection

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

Parameters

collection

- existing source collection

Returns

A newly initialized array with the ascending sorted objects

Exceptions

SCCollectionException

- collection error detected

See also

- initWithSortedCollection:

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

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

Parameters

collection	- existing source collection
sorter	- data sorter

Returns

A newly initialized array with the ascending sorted objects

Exceptions

SCCollectionException

- collection error detected

See also

- initWithSortedCollection:sorter:

- (id) initWithCollection:

(id)

collection

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

Parameters

collection

- existing source collection

Returns

A newly initialized array

Exceptions

SCCollectionException

- collection error detected

Reimplemented from SCCollection.

- (id) initWithDescendingSortedCollection:

(id)

collection

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

Parameters

collection

- existing source collection

Returns

A newly initialized array with the descending sorted objects

Exceptions

SCCollectionException

- collection error detected

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

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

Parameters

collection	- existing source collection
sorter	- data sorter

Returns

A newly initialized array with the descending sorted objects

Exceptions

SCCollectionException

- collection error detected

- (id) initWithName:

(NSString *)

name

Initializes an empty array using the specified array name.

Attention

Designed initializer

Parameters

name	- array name

Returns

A newly initialized array

- (id) initWithObject:

(id)

object

Initializes an array using the specified existing object.

Parameters

object

- existing source object

Returns

A newly initialized array

Exceptions

SCCollectionException

- collection error detected

- (id) initWithObjects:		(id)	object
,			NS_REQUIRES_NIL_TERMINATION

Initializes an array using the existing objects from the specified nil terminated list.

Parameters

object	- first source object
...	- other source objects
NS_REQUIRES_NIL_TERMINATION	- mandatory nil pointer

Returns

A newly initialized array

- (id) initWithSortedCollection:

(id)

collection

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

Parameters

collection

- existing source collection

Returns

A newly initialized array with the ascending sorted objects

Exceptions

SCCollectionException

- collection error detected

See also

- initWithAscendingSortedCollection:

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

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

Parameters

collection	- existing source collection
sorter	- data sorter

Returns

A newly initialized array with the ascending sorted objects

Exceptions

SCCollectionException

- collection error detected

See also

- initWithAscendingSortedCollection:sorter:

- (void) insertAtIndex:		(SCIndex)	index
objects:		(id)	object
,			NS_REQUIRES_NIL_TERMINATION

Inserts the objects from the specified nil terminated list into the receiving array at a given index.

Parameters

index	- index at which to insert objects
object	- first inserting object
...	- other inserting objects
NS_REQUIRES_NIL_TERMINATION	- mandatory nil pointer

Exceptions

SCCollectionException

- collection error detected

- (void) insertAtIndexes:		(NSIndexSet *)	indexes
objects:		(id)	object
,			NS_REQUIRES_NIL_TERMINATION

Inserts the objects from the specified nil terminated list into the receiving array at a given indexes.

Parameters

indexes	- indexes at which the objects should be inserted
object	- first object to insert into the receiving array
...	- other inserting objects
NS_REQUIRES_NIL_TERMINATION	- mandatory nil pointer

Exceptions

SCCollectionException

- collection error detected

- (void) insertBool:		(BOOL)	value
atIndex:		(SCIndex)	index

Inserts into the receiving array the specified boolean value at a given index.

Parameters

value	- inserting value
index	- index at which to insert value

Exceptions

SCCollectionException

- collection error detected

- (void) insertByte:		(SCByte)	value
atIndex:		(SCIndex)	index

Inserts into the receiving array the specified signed 8-bit integer value at a given index.

Parameters

value	- inserting value
index	- index at which to insert value

Exceptions

SCCollectionException

- collection error detected

- (void) insertChar:		(char)	value
atIndex:		(SCIndex)	index

Inserts into the receiving array the specified character at a given index.

Parameters

value	- inserting character
index	- index at which to insert character

Exceptions

SCCollectionException

- collection error detected

See also

- insertUnichar:atIndex:

- (void) insertCharString:		(const char *)	string
atIndex:		(SCIndex)	index

Inserts into the receiving array the specified character string at a given index.

Parameters

string	- inserting character string
index	- index at which to insert character

Exceptions

SCCollectionException

- collection error detected

- (void) insertCollection:		(id)	collection
atIndex:		(SCIndex)	index

Inserts the objects from the specified collection of any supported type into the receiving array at a given index.

Parameters

collection	- collection of objects to insert into the receiving array at the specified index
index	- index at which to insert objects from the specified collection

Exceptions

SCCollectionException

- collection error detected

- (void) insertCollection:		(id)	collection
atIndexes:		(NSIndexSet *)	indexes

Inserts the objects from the provided collection of any supported type into the receiving array at the specified indexes.

Parameters

collection	- collection of objects to insert into the receiving array
indexes	- indexes at which the objects should be inserted

Exceptions

SCCollectionException

- collection error detected

- (void) insertDouble:		(SCDouble)	value
atIndex:		(SCIndex)	index

Inserts into the receiving array the specified double value at a given index.

Parameters

value	- inserting value
index	- index at which to insert value

Exceptions

SCCollectionException

- collection error detected

- (void) insertFloat:		(SCFloat)	value
atIndex:		(SCIndex)	index

Inserts into the receiving array the specified float value at a given index.

Parameters

value	- inserting value
index	- index at which to insert value

Exceptions

SCCollectionException

- collection error detected

- (void) insertInteger:		(SCInteger)	value
atIndex:		(SCIndex)	index

Inserts into the receiving array the specified signed 32-bit integer value at a given index.

Parameters

value	- inserting value
index	- index at which to insert value

Exceptions

SCCollectionException

- collection error detected

- (void) insertLong:		(SCLong)	value
atIndex:		(SCIndex)	index

Inserts into the receiving array the specified signed 64-bit integer value at a given index.

Parameters

value	- inserting value
index	- index at which to insert value

Exceptions

SCCollectionException

- collection error detected

- (void) insertObject:		(id)	object
atIndex:		(SCIndex)	index

Inserts into the receiving array the specified existing object at a given index.

Parameters

object	- inserting existing object
index	- index at which to insert object

Exceptions

SCCollectionException

- collection error detected

Reimplemented from <SCMutableIndexedCollection>.

- (void) insertShort:		(SCShort)	value
atIndex:		(SCIndex)	index

Inserts into the receiving array the specified signed 16-bit integer value at a given index.

Parameters

value	- inserting value
index	- index at which to insert value

Exceptions

SCCollectionException

- collection error detected

- (void) insertUByte:		(SCUByte)	value
atIndex:		(SCIndex)	index

Inserts into the receiving array the specified unsigned 8-bit integer value at a given index.

Parameters

value	- inserting value
index	- index at which to insert value

Exceptions

SCCollectionException

- collection error detected

- (void) insertUInteger:		(SCUInteger)	value
atIndex:		(SCIndex)	index

Inserts into the receiving array the specified unsigned 32-bit integer value at a given index.

Parameters

value	- inserting value
index	- index at which to insert value

Exceptions

SCCollectionException

- collection error detected

- (void) insertULong:		(SCULong)	value
atIndex:		(SCIndex)	index

Inserts into the receiving array the specified unsigned 64-bit integer value at a given index.

Parameters

value	- inserting value
index	- index at which to insert value

Exceptions

SCCollectionException

- collection error detected

- (void) insertUnichar:		(unichar)	value
atIndex:		(SCIndex)	index

Inserts into the receiving array the specified character at a given index.

Parameters

value	- inserting character
index	- index at which to insert character

Exceptions

SCCollectionException

- collection error detected

See also

- insertChar:atIndex:

- (void) insertUShort:		(SCUShort)	value
atIndex:		(SCIndex)	index

Inserts into the receiving array the specified unsigned 16-bit integer value at a given index.

Parameters

value	- inserting value
index	- index at which to insert value

Exceptions

SCCollectionException

- collection error detected

- (BOOL) isEqualToArray:

(SCArray *)

array

Returns a boolean value that indicates whether the content and settings of the receiving array are equal to the content and settings of another given array.

Parameters

array

- array with which to compare the receiving array

Returns

YES if the content and settings of other array are equal to the content and settings of the receiving array, otherwise NO

- (BOOL) isEqualToContentsOfArray:

(SCArray *)

array

Returns a boolean value that indicates whether the content of the receiving array is equals to the content of another given array.

Parameters

array

- array with which to compare the receiving array

Returns

YES if the content of other array is equals to the content of the receiving array, otherwise NO

- (void) moveObjectAtIndex:		(SCIndex)	index
toIndex:		(SCIndex)	destination

Moves the object ath the specified source index to a given destination index.

Parameters

index	- source index of the object to be move
destination	- destination index

Exceptions

SCCollectionException

- collection error detected

- (void) moveObjectsInRange:		(NSRange)	range
toIndex:		(SCIndex)	destination

Moves the objects in the specified range to a given destination index.

Parameters

range	- range of the objects to be move
destination	- destination index

Exceptions

SCCollectionException

- collection error detected

- (NSNumber *) numberAtIndex:

(SCIndex)

index

Returns the number located at the specified index.

Parameters

index

- index within the bounds of the array

Returns

The number located at the specified index

Exceptions

SCCollectionException

- collection error detected

- (id) objectAtIndex:

(SCIndex)

index

Returns the object located at the specified index.

Parameters

index

- index within the bounds of the array

Returns

The object located at the specified index

Exceptions

SCCollectionException

- collection error detected

Reimplemented from <SCIndexedCollection>.

- (SCArray *) objectsAtIndexes:

(NSIndexSet *)

indexes

Returns an array containing the objects in the receving array at the indexes specified by a given index set.

Parameters

indexes

- index set with indexes of the required objects

Returns

Array with the required objects

Exceptions

SCCollectionException

- collection error detected

- (SCArray *) objectsInRange:

(NSRange)

range

Returns an array containg the objects in the receiving array in the specified range.

Parameters

range

- range of the requited objects

Returns

Array with the objecst in the specified range

Exceptions

SCCollectionException

- collection error detected

- (void) removeFirstObject

Removes the first object from the receiving array.

Exceptions

SCCollectionException

- collection error detected

- (void) removeLastObject

Removes the object with the highest-valued index in the receiving array.

Exceptions

SCCollectionException

- collection error detected

- (void) removeObjectAtIndex:

(SCIndex)

index

Removes from the receiving array the object at the specified index.

Parameters

index

- index from which to remove the object in the array

Exceptions

SCCollectionException

- collection error detected

Reimplemented from <SCMutableIndexedCollection>.

- (void) removeObjectsAtIndexes:

(NSIndexSet *)

indexes

Removes the objects at the specified indexes from the receiving array.

Parameters

indexes

- indexes of the objects to remove from the array

Exceptions

SCCollectionException

- collection error detected

Reimplemented from <SCMutableIndexedCollection>.

- (void) removeObjectsInRange:

(NSRange)

range

Removes from the receiving array each of the objects within a given range.

Parameters

range

- range of objects to be removed from the array

Exceptions

SCCollectionException

- collection error detected

- (void) replaceObjectAtIndex:		(SCIndex)	index
withBool:		(BOOL)	value

Replaces the object at the specified index with a given boolean value.

Parameters

index	- index of the object to be replaced
value	- value with which to replace the object at the specified index

Exceptions

SCCollectionException

- collection error detected

- (void) replaceObjectAtIndex:		(SCIndex)	index
withByte:		(SCByte)	value

Replaces the object at the specified index with a given signed 8-bit integer value.

Parameters

index	- index of the object to be replaced
value	- value with which to replace the object at the specified index

Exceptions

SCCollectionException

- collection error detected

- (void) replaceObjectAtIndex:		(SCIndex)	index
withChar:		(char)	value

Replaces the object at the specified index with a given character.

Parameters

index	- index of the object to be replaced
value	- character with which to replace the object at the specified index

Exceptions

SCCollectionException

- collection error detected

See also

- replaceObjectAtIndex:withUnichar:

- (void) replaceObjectAtIndex:		(SCIndex)	index
withCharString:		(const char *)	string

Replaces the object at the specified index with a given character string.

Parameters

index	- index of the object to be replaced
string	- character string with which to replace the object at the specified index

Exceptions

SCCollectionException

- collection error detected

- (void) replaceObjectAtIndex:		(SCIndex)	index
withDouble:		(SCDouble)	value

Replaces the object at the specified index with a given double value.

Parameters

index	- index of the object to be replaced
value	- value with which to replace the object at the specified index

Exceptions

SCCollectionException

- collection error detected

- (void) replaceObjectAtIndex:		(SCIndex)	index
withFloat:		(SCFloat)	value

Replaces the object at the specified index with a given float value.

Parameters

index	- index of the object to be replaced
value	- value with which to replace the object at the specified index

Exceptions

SCCollectionException

- collection error detected

- (void) replaceObjectAtIndex:		(SCIndex)	index
withInteger:		(SCInteger)	value

Replaces the object at the specified index with a given signed 32-bit integer value.

Parameters

index	- index of the object to be replaced
value	- value with which to replace the object at the specified index

Exceptions

SCCollectionException

- collection error detected

- (void) replaceObjectAtIndex:		(SCIndex)	index
withLong:		(SCLong)	value

Replaces the object at the specified index with a given signed 64-bit integer value.

Parameters

index	- index of the object to be replaced
value	- value with which to replace the object at the specified index

Exceptions

SCCollectionException

- collection error detected

- (void) replaceObjectAtIndex:		(SCIndex)	index
withObject:		(id)	object

Replaces the object at the specified index with a given object.

Parameters

index	- index of the object to be replaced
object	- object with which to replace the object at the specified index

Exceptions

SCCollectionException

- collection error detected

Reimplemented from <SCMutableIndexedCollection>.

- (void) replaceObjectAtIndex:		(SCIndex)	index
withShort:		(SCShort)	value

Replaces the object at the specified index with a given signed 16-bit integer value.

Parameters

index	- index of the object to be replaced
value	- value with which to replace the object at the specified index

Exceptions

SCCollectionException

- collection error detected

- (void) replaceObjectAtIndex:		(SCIndex)	index
withUByte:		(SCUByte)	value

Replaces the object at the specified index with a given unsigned 8-bit integer value.

Parameters

index	- index of the object to be replaced
value	- value with which to replace the object at the specified index

Exceptions

SCCollectionException

- collection error detected

- (void) replaceObjectAtIndex:		(SCIndex)	index
withUInteger:		(SCUInteger)	value

Replaces the object at the specified index with a given unsigned 32-bit integer value.

Parameters

index	- index of the object to be replaced
value	- value with which to replace the object at the specified index

Exceptions

SCCollectionException

- collection error detected

- (void) replaceObjectAtIndex:		(SCIndex)	index
withULong:		(SCULong)	value

Replaces the object at the specified index with a given unsigned 64-bit integer value.

Parameters

index	- index of the object to be replaced
value	- value with which to replace the object at the specified index

Exceptions

SCCollectionException

- collection error detected

- (void) replaceObjectAtIndex:		(SCIndex)	index
withUnichar:		(unichar)	value

Replaces the object at the specified index with a given character.

Parameters

index	- index of the object to be replaced
value	- character with which to replace the object at the specified index

Exceptions

SCCollectionException

- collection error detected

See also

- replaceObjectAtIndex:withChar:

- (void) replaceObjectAtIndex:		(SCIndex)	index
withUShort:		(SCUShort)	value

Replaces the object at the specified index with a given unsigned 16-bit integer value.

Parameters

index	- index of the object to be replaced
value	- value with which to replace the object at the specified index

Exceptions

SCCollectionException

- collection error detected

- (void) replaceObjectsAtIndexes:		(NSIndexSet *)	indexes
withCollection:		(id)	collection

Replaces the objects in the receiving array at the specified indexes with the objects from a given collection of any supported type.

Parameters

indexes	- indexes of the objects to be replaced
collection	- collection with the objects with which to replace the objects in the receiving array

Exceptions

SCCollectionException

- collection error detected

- (void) replaceObjectsAtIndexes:		(NSIndexSet *)	indexes
withObjects:		(id)	object
,			NS_REQUIRES_NIL_TERMINATION

Replaces the objects in the receiving array at locations specified with the objects from a given nil teminated list.

Parameters

indexes	- indexes of the objects to be replaced
object	- first object with which to replace the objects in the receiving array
...	- other objects with which to replace the objects in the receiving array
NS_REQUIRES_NIL_TERMINATION	- mandatory nil pointer

Exceptions

SCCollectionException

- collection error detected

- (void) replaceObjectsInRange:		(NSRange)	range
withCollection:		(id)	collection

Replaces the objects in the receiving array specified by a given range with the objects from a given collection of any supported type.

Parameters

range	- range of objects to be replaced in (or removed from) the receiving array
collection	- collection of objects from which to select replacements for the objects in the specified range

Exceptions

SCCollectionException

- collection error detected

- (void) replaceObjectsInRange:		(NSRange)	range
withObjects:		(id)	object
,			NS_REQUIRES_NIL_TERMINATION

Replaces the objects in the receiving array specified by a given range with the objects from a given nil terminated list.

Parameters

range	- range of objects to be replaced in (or removed from) the receiving array
object	- first object with which to replace the objects in the receiving array
...	- other objects with which to replace the objects in the receiving array
NS_REQUIRES_NIL_TERMINATION	- mandatory nil pointer

Exceptions

SCCollectionException

- collection error detected

- (void) reverse

Reverses the order of all objects in the receiving array.

Exceptions

SCCollectionException

- collection error detected

- (void) setArray:

(SCArray *)

array

Replaces the content and settings of the receiving array by using the content and settings from the specified existing array.

Parameters

array

- existing source array

Exceptions

SCCollectionException

- collection error detected

- (void) setAscendingSortedCollection:

(id)

collection

Replaces the settings and content of the receiving array by using the settings and ascending sorted content of the specified existing collection of any supported type.

Parameters

collection

- existing source collection

Exceptions

SCCollectionException

- collection error detected

See also

- setSortedCollection:

- (void) setAscendingSortedCollection:		(id)	collection
sorter:		(id<SCSorter>)	sorter

Replaces the settings and content of the receiving array by using the settings and ascending sorted content of the specified existing source collection of any supported type with a given data sorter.

Parameters

collection	- existing source collection
sorter	- data sorter

Exceptions

SCCollectionException

- collection error detected

See also

- setSortedCollection:sorter:

- (void) setBool:		(BOOL)	value
atIndex:		(SCIndex)	index

Replaces the object at the specified index with a given boolean value, possibly adding the value.

Parameters

value	- value with which to replace the object at the specified index
index	- index of the object to be replaced

Exceptions

SCCollectionException

- collection error detected

- (void) setByte:		(SCByte)	value
atIndex:		(SCIndex)	index

Replaces the object at the specified index with a given signed 8-bit integer value, possibly adding the value.

Parameters

value	- value with which to replace the object at the specified index
index	- index of the object to be replaced

Exceptions

SCCollectionException

- collection error detected

- (void) setChar:		(char)	value
atIndex:		(SCIndex)	index

Replaces the object at the specified index with a given character, possibly adding the character.

Parameters

value	- character with which to replace the object at the specified index
index	- index of the object to be replaced

Exceptions

SCCollectionException

- collection error detected

See also

- setUnichar:atIndex:

- (void) setCharString:		(const char *)	string
atIndex:		(SCIndex)	index

Replaces the object at the specified index with a given character string, possibly adding the character string.

Parameters

string	- character string with which to replace the object at the specified index
index	- index of the object to be replaced

Exceptions

SCCollectionException

- collection error detected

- (void) setDescendingSortedCollection:

(id)

collection

Replaces the settings and content of the receiving array by using the settings and descending sorted content of the specified existing collection of any supported type.

Parameters

collection

- existing source collection

Exceptions

SCCollectionException

- collection error detected

- (void) setDescendingSortedCollection:		(id)	collection
sorter:		(id<SCSorter>)	sorter

Replaces the settings and content of the receiving array by using the settings and descending sorted content of the specified existing source collection of any supported type with a given data sorter.

Parameters

collection	- existing source collection
sorter	- data sorter

Exceptions

SCCollectionException

- collection error detected

- (void) setDouble:		(SCDouble)	value
atIndex:		(SCIndex)	index

Replaces the object at the specified index with a given double value, possibly adding the value.

Parameters

value	- value with which to replace the object at the specified index
index	- index of the object to be replaced

Exceptions

SCCollectionException

- collection error detected

- (void) setFloat:		(SCFloat)	value
atIndex:		(SCIndex)	index

Replaces the object at the specified index with a given float value, possibly adding the value.

Parameters

value	- value with which to replace the object at the specified index
index	- index of the object to be replaced

Exceptions

SCCollectionException

- collection error detected

- (void) setInteger:		(SCInteger)	value
atIndex:		(SCIndex)	index

Replaces the object at the specified index with a given signed 32-bit integer value, possibly adding the value.

Parameters

value	- value with which to replace the object at the specified index
index	- index of the object to be replaced

Exceptions

SCCollectionException

- collection error detected

- (void) setLong:		(SCLong)	value
atIndex:		(SCIndex)	index

Replaces the object at the specified index with a given signed 64-bit integer value, possibly adding the value.

Parameters

value	- value with which to replace the object at the specified index
index	- index of the object to be replaced

Exceptions

SCCollectionException

- collection error detected

- (void) setObject:		(id)	object
atIndex:		(SCIndex)	index

Replaces the object at the specified index with the new object, possibly adding the object.

Parameters

object	- object with which to replace the object at the specified index
index	- index of the object to be replaced

Exceptions

SCCollectionException

- collection error detected

- (void) setShort:		(SCShort)	value
atIndex:		(SCIndex)	index

Replaces the object at the specified index with a given signed 16-bit integer value, possibly adding the value.

Parameters

value	- value with which to replace the object at the specified index
index	- index of the object to be replaced

Exceptions

SCCollectionException

- collection error detected

- (void) setSortedCollection:

(id)

collection

Replaces the settings and content of the receiving array by using the settings and ascending sorted content of the specified existing collection of any supported type.

Parameters

collection

- existing source collection

Exceptions

SCCollectionException

- collection error detected

See also

- setAscendingSortedCollection:

- (void) setSortedCollection:		(id)	collection
sorter:		(id<SCSorter>)	sorter

Replaces the settings and content of the receiving array by using the settings and ascending sorted content of the specified existing collection of any supported type with a given data sorter.

Parameters

collection	- existing source collection
sorter	- data sorter

Exceptions

SCCollectionException

- collection error detected

See also

- setAscendingSortedCollection:sorter:

- (void) setUByte:		(SCUByte)	value
atIndex:		(SCIndex)	index

Replaces the object at the specified index with a given unsigned 8-bit integer value, possibly adding the value.

Parameters

value	- value with which to replace the object at the specified index
index	- index of the object to be replaced

Exceptions

SCCollectionException

- collection error detected

- (void) setUInteger:		(SCUInteger)	value
atIndex:		(SCIndex)	index

Replaces the object at the specified index with a given unsigned 32-bit integer value, possibly adding the value.

Parameters

value	- value with which to replace the object at the specified index
index	- index of the object to be replaced

Exceptions

SCCollectionException

- collection error detected

- (void) setULong:		(SCULong)	value
atIndex:		(SCIndex)	index

Replaces the object at the specified index with a given unsigned 64-bit integer value, possibly adding the value.

Parameters

value	- value with which to replace the object at the specified index
index	- index of the object to be replaced

Exceptions

SCCollectionException

- collection error detected

- (void) setUnichar:		(unichar)	value
atIndex:		(SCIndex)	index

Replaces the object at the specified index with a given character, possibly adding the character.

Parameters

value	- character with which to replace the object at the specified index
index	- index of the object to be replaced

Exceptions

SCCollectionException

- collection error detected

See also

- setChar:atIndex:

- (void) setUShort:		(SCUShort)	value
atIndex:		(SCIndex)	index

Replaces the object at the specified index with a given unsigned 16-bit integer value, possibly adding the value.

Parameters

value	- value with which to replace the object at the specified index
index	- index of the object to be replaced

Exceptions

SCCollectionException

- collection error detected

- (void) sort

Sorts ascending the receiving array using the default data sorter.

Exceptions

SCCollectionException

- collection error detected

See also

- sortAscending

- (void) sortAscending

Sorts ascending the receiving array using the default data sorter.

Exceptions

SCCollectionException

- collection error detected

See also

- sort

- (void) sortAscendingWithSorter:

(id<SCSorter>)

sorter

Sorts ascending the receiving array using the specified data sorter.

Parameters

sorter

- data sorter

Exceptions

SCCollectionException

- collection error detected

See also

- sortWithSorter:

- (void) sortDescending

Sorts descending the receiving array using the default data sorter.

Exceptions

SCCollectionException

- collection error detected

- (void) sortDescendingWithSorter:

(id<SCSorter>)

sorter

Sorts descending the receiving array using the specified data sorter.

Parameters

sorter

- data sorter

Exceptions

SCCollectionException

- collection error detected

- (SCArray *) 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

- data sorter

Returns

Array with sorted objects

Exceptions

SCCollectionException

- collection error detected

See also

- ascendingSortedArrayWithSorter:

- (void) sortWithSorter:

(id<SCSorter>)

sorter

Sorts ascending the receiving array using the specified data sorter.

Parameters

sorter

- data sorter

Exceptions

SCCollectionException

- collection error detected

See also

- sortAscendingWithSorter:

- (NSString *) stringAtIndex:

(SCIndex)

index

Returns the string located at the specified index.

Parameters

index

- index within the bounds of the array

Returns

The string located at the specified index

Exceptions

SCCollectionException

- collection error detected

Property Documentation

- (NSNumber *) firstNumber

readnonatomicretain

First object in the array as a number

- (id) firstObject

readnonatomicretain

Fist object in the array

- (NSString *) firstString

readnonatomicretain

First object in the array as a string

- (SCIndex) indexOfLastObject

readnonatomicassign

Index of the array last object

- (NSNumber *) lastNumber

readnonatomicretain

Last object in the array as a number

- (id) lastObject

readnonatomicretain

Last object in the array

- (NSString *) lastString

readnonatomicretain

Last object in the array as a string

- (SCArray *) reversedArray

readnonatomicretain

Array with objects in reverse order

- (SCArray *) sortedArray

readnonatomicretain

Array with ascending sorted objects

---

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

• SCArray.h
• SCArray.m