Abstract collections class. More...

#import <SCCollection.h>

Inheritance diagram for SCCollection:

Instance Properties
NSString *	name

BOOL	readOnly

id< SCCollectionDelegate >	delegate

SCULong	count

BOOL	empty

NSString *	typeName

NSString *	description

Initializing Collections
(id)	- initWithCollection:

Copying Collections
(void)	- setCollection:

(void)	- setObject:

(void)	- setObjects:

Comparing Collections
(BOOL)	- isEqualToCollection:

(BOOL)	- isEqualToContentsOfCollection:

(BOOL)	- isEqual:

Objects Enumerators
NSEnumerator *	objectEnumerator

NSEnumerator *	reverseObjectEnumerator

(void)	- enumerateWithDelegate:

(void)	- enumerate

(void)	- reverseEnumerateWithDelegate:

(void)	- reverseEnumerate

Converting Collections
(SCArray *)	- array

(SCSet *)	- set

(SCOrderedSet *)	- orderedSet

(SCDictionary *)	- dictionary

(SCStack *)	- stack

(SCQueue *)	- queue

(SCUnidirectionalList *)	- unidirectionalList

(SCBidirectionalList *)	- bidirectionalList

(NSArray *)	- foundationArray

(NSSet *)	- foundationSet

(NSOrderedSet *)	- foundationOrderedSet

(NSDictionary *)	- foundationDictionary

Adding Objects
(void)	- addObject:

(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:

Removing Objects
(void)	- removeAllObjects

(void)	- removeObjectsWithClass:

(void)	- removeObjectsWithClassName:

(void)	- removeCollection:

(void)	- removeObject:

(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:

Finding Objects in a Collection
(BOOL)	- containsObject:

(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:

Detecting Collection Type
(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

(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:

Additional Inherited Members
Instance Methods inherited from SCObject
(id)	- initWithContentsOfSerializedFile:

(BOOL)	- writeContentsToSerializedFile:

(id)	- initWithDataDictionaryFromFile:

(void)	- writeToDataDictionaryFile:atomically:

(void)	- writeToDataDictionaryFile:

(NSDictionary *)	- dataDictionary

(id)	- initWithFileStream:

(void)	- writeToFileStream:

(void)	- appendToFileStream:

(SCComparisonResult)	- compareWithObject:

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>
(NSString *)	- description

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

Abstract collections class.

Since: version 1.1.3

Contains the declaration of all collection mandatory methods.@ Class instances can thrown the following exceptions:

Todo:

Methods such setByAdddingObject: and so on

Change parameters type from id to id<SCCollection>

Method Documentation

- (void) addBool: (BOOL) value

Adds into the receiving collection the specified boolean value.

Parameters

value - added value

Exceptions

SCCollectionException - collection error detected

- (void) addByte: (SCByte) value

Adds into the receiving collection the specified signed 8-bit integer value.

Parameters

value - added value

Exceptions

SCCollectionException - collection error detected

- (void) addChar: (char) value

Adds into the receiving collection the specified character value.

Parameters

value - added value

Exceptions

SCCollectionException - collection error detected

- (void) addCharString: (const char *) string

Adds into the receiving collection the specified character string.

Parameters

string - added character string

Exceptions

SCCollectionException - collection error detected

- (void) addCollection: (id) collection

Adds into the receiving collection the objects from the specified existing collection of any supported type.

Parameters

collection - existing source collection

Exceptions

SCCollectionException - collection error detected

Reimplemented from <SCMutableCollection>.

- (void) addDouble: (SCDouble) value

Adds into the receiving collection the specified double value.

Parameters

value - added value

Exceptions

SCCollectionException - collection error detected

- (void) addFloat: (SCFloat) value

Adds into the receiving collection the specified float value.

Parameters

value - added value

Exceptions

SCCollectionException - collection error detected

- (void) addInteger: (SCInteger) value

Adds into the receiving collection the specified signed 32-bit integer value.

Parameters

value - added value

Exceptions

SCCollectionException - collection error detected

- (void) addLong: (SCLong) value

Adds into the receiving collection the specified signed 64-bit integer value.

Parameters

value - added value

Exceptions

SCCollectionException - collection error detected

- (void) addObject: (id) object

Adds into the receiving collection the specified existing object.

Parameters

object - added existing object

Exceptions

SCCollectionException - collection error detected

Reimplemented from <SCMutableCollection>.

- (void) addObjects:	(id)	object
,		NS_REQUIRES_NIL_TERMINATION

Adds into the receiving collection the objects from the specified nil terminated list.

Parameters

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

Exceptions

SCCollectionException - collection error detected

Reimplemented from <SCMutableCollection>.

- (void) addShort: (SCShort) value

Adds into the receiving collection the specified signed 16-bit integer value.

Parameters

value - added value

Exceptions

SCCollectionException - collection error detected

- (void) addUByte: (SCUByte) value

Adds into the receiving collection the specified unsigned 8-bit integer value.

Parameters

value - added value

Exceptions

SCCollectionException - collection error detected

- (void) addUInteger: (SCUInteger) value

Adds into the receiving collection the specified unsigned 32-bit integer value.

Parameters

value - added value

Exceptions

SCCollectionException - collection error detected

- (void) addULong: (SCULong) value

Adds into the receiving collection the specified unsigned 64-bit integer value.

Parameters

value - added value

Exceptions

SCCollectionException - collection error detected

- (void) addUnichar: (unichar) value

Adds into the receiving collection the specified character value.

Parameters

value - added value

Exceptions

SCCollectionException - collection error detected

- (void) addUShort: (SCUShort) value

Adds into the receiving collection the specified unsigned 16-bit integer value.

Parameters

value - added value

Exceptions

SCCollectionException - collection error detected

- (SCArray *) array

Returns an array with the all objects from the receiving collection.

Returns: Array with objects

Reimplemented from <SCCollection>.

Reimplemented in SCArray.

- (SCBidirectionalList *) bidirectionalList

Returns a bidirectional list with the all objects from the receiving collection.

Returns: Bidirectional list with objects

Reimplemented from <SCCollection>.

- (BOOL) containsAnyObject:	(id)	object
,		NS_REQUIRES_NIL_TERMINATION

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

Parameters

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

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

Reimplemented from <SCCollection>.

- (BOOL) containsAnyObjectFromCollection: (id) collection

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

Parameters

collection - collection with the desired objects

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

Reimplemented from <SCCollection>.

- (BOOL) containsBool: (BOOL) value

Returns a boolean value that indicates whether a given boolean value is present in the receiving collection.

Parameters

value - desired value

Returns: YES if a given value is present in the receiving collection, otherwise NO

- (BOOL) containsByte: (SCByte) value

Returns a boolean value that indicates whether a given signed 8-bit integer value is present in the receiving collection.

Parameters

value - desired value

Returns: YES if a given value is present in the receiving collection, otherwise NO

- (BOOL) containsChar: (char) value

Returns a boolean value that indicates whether a given character is present in the receiving collection.

Parameters

value - desired character

Returns: YES if a given character is present in the receiving collection, otherwise NO

- (BOOL) containsCharString: (const char *) string

Returns a boolean value that indicates whether a given character string is present in the receiving collection.

Parameters

string - desired character string

Returns: YES if a given character string is present in the receiving collection, otherwise NO

- (BOOL) containsCollection: (id) collection

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

Parameters

collection - collection with desired objects

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

Reimplemented from <SCCollection>.

- (BOOL) containsDouble: (SCDouble) value

Returns a boolean value that indicates whether a given double value is present in the receiving collection.

Parameters

value - desired value

Returns: YES if a given value is present in the receiving collection, otherwise NO

- (BOOL) containsFloat: (SCFloat) value

Returns a boolean value that indicates whether a given float value is present in the receiving collection.

Parameters

value - desired value

Returns: YES if a given value is present in the receiving collection, otherwise NO

- (BOOL) containsInteger: (SCInteger) value

Returns a boolean value that indicates whether a given signed 32-bit integer value is present in the receiving collection.

Parameters

value - desired value

Returns: YES if a given value is present in the receiving collection, otherwise NO

- (BOOL) containsLong: (SCLong) value

Returns a boolean value that indicates whether a given signed 64-bit integer value is present in the receiving collection.

Parameters

value - desired value

Returns: YES if a given value is present in the receiving collection, otherwise NO

- (BOOL) containsObject: (id) object

Returns a boolean value that indicates whether an equivalent of a given object is present in the receiving collection.

Parameters

object - desired object

Returns: YES if a given object is present in the receiving collection, otherwise NO

Reimplemented from <SCCollection>.

- (BOOL) containsObjects:	(id)	object
,		NS_REQUIRES_NIL_TERMINATION

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

Parameters

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

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

Reimplemented from <SCCollection>.

- (BOOL) containsShort: (SCShort) value

Returns a boolean value that indicates whether a given signed 16-bit integer value is present in the receiving collection.

Parameters

value - desired value

Returns: YES if a given value is present in the receiving collection, otherwise NO

- (BOOL) containsUByte: (SCUByte) value

Returns a boolean value that indicates whether a given unsigned 8-bit integer value is present in the receiving collection.

Parameters

value - desired value

Returns: YES if a given value is present in the receiving collection, otherwise NO

- (BOOL) containsUInteger: (SCUInteger) value

Returns a boolean value that indicates whether a given unsigned 32-bit integer value is present in the receiving collection.

Parameters

value - desired value

Returns: YES if a given value is present in the receiving collection, otherwise NO

- (BOOL) containsULong: (SCULong) value

Returns a boolean value that indicates whether a given unsigned 64-bit integer value is present in the receiving collection.

Parameters

value - desired value

Returns: YES if a given value is present in the receiving collection, otherwise NO

- (BOOL) containsUnichar: (unichar) value

Returns a boolean value that indicates whether a given character is present in the receiving collection.

Parameters

value - desired character

Returns: YES if a given character is present in the receiving collection, otherwise NO

- (BOOL) containsUShort: (SCUShort) value

Returns a boolean value that indicates whether a given unsigned 16-bit integer value is present in the receiving collection.

Parameters

value - desired value

Returns: YES if a given value is present in the receiving collection, otherwise NO

- (SCDictionary *) dictionary

Returns a dictionary with the all objects from the receiving collection.

Returns: Dictionary with objects

Reimplemented from <SCCollection>.

Reimplemented in SCDictionary.

- (void) enumerate

Tells the instance delegate object for each object in the receiving collection.

- (void) enumerateWithDelegate: (id<SCCollectionDelegate>) delegate

Tells the specified delegate object for each object in the receiving collection.

Parameters

delegate - delegate object

- (NSArray *) foundationArray

Returns a class NSArray instance with the all objects from the receiving collection.

Returns: Class NSArray instance with objects

Reimplemented from <SCCollection>.

- (NSDictionary *) foundationDictionary

Returns a class NSDictionary instance with the all objects from the receiving collection.

Returns: Class NSDictionary instance with objects

Reimplemented from <SCCollection>.

- (NSOrderedSet *) foundationOrderedSet

Returns a class NSOrderedSet instance with the all objects from the receiving collection.

Returns: Class NSOrderedSet instance with objects

Reimplemented from <SCCollection>.

- (NSSet *) foundationSet

Returns a class NSSet instance with the all objects from the receiving collection.

Returns: Class NSSet instance with objects

Reimplemented from <SCCollection>.

- (id) initWithCollection: (id) collection

Initializes a collection using the specified existing collection of any supported type.

Parameters

collection - existing source collection

Returns: A newly initialized collection

Exceptions

SCCollectionException - collection error detected

Reimplemented from <SCCollection>.

Reimplemented in SCArray, SCOrderedSet, SCDictionary, SCQueue, SCList, SCStack, and SCSet.

- (BOOL) isArray

Returns a boolean value that indicates whether the receiving instance is an array of any supported type.

Returns: YES if the receiving instance is an array, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isArray: (id) object

Returns a boolean value that indicates whether a given object is an instance of any array class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of an array class, otherwise NO

+ (BOOL) isArrayClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any supported array class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of an array class, otherwise NO

- (BOOL) isCollection

Returns a boolean value that indicates whether the receiving instance is a collection of any supported type.

Returns: YES if the receiving instance is a collection, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isCollection: (id) object

Returns a boolean value that indicates whether a given object is an instance of any collection class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of a collection class, otherwise NO

+ (BOOL) isCollectionClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any supported collection class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of a collection class, otherwise NO

- (BOOL) isDictionary

Returns a boolean value that indicates whether the receiving instance is a dictionary of any supported type.

Returns: YES if the receiving instance is a dictionary, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isDictionary: (id) object

Returns a boolean value that indicates whether a given object is an instance of any dictionary class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of a dictionary class, otherwise NO

+ (BOOL) isDictionaryClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any dictionary class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of a dictionary class, otherwise NO

- (BOOL) isEqual: (id) object

Returns a boolean value that indicates whether the receiving collection is equals to the specified object.

Parameters

object - object with which to compare the receiving collection

Returns: YES if the object is equals to the receiving collection, otherwise NO

Reimplemented from SCObject.

- (BOOL) isEqualToCollection: (id) collection

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

Parameters

collection - collection with which to compare the receiving collection

Returns: YES if the content and settings of other collection are equal to the content and setting of the receiving collection, otherwise NO

- (BOOL) isEqualToContentsOfCollection: (id) collection

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

Parameters

collection - collection with which to compare the receiving collection

Returns: YES if the content of other collection is equals to the content of the receiving collection, otherwise NO

- (BOOL) isFoundationArray

Returns a boolean value that indicates whether the reciving instance is a standard array.

Returns: YES if the receiving instance is a standard array, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isFoundationArray: (id) object

Returns a boolean value that indicates whether a given object is an instance of any standard array class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of a standard array class, otherwise NO

+ (BOOL) isFoundationArrayClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any standard array class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of a standard array class, otherwise NO

- (BOOL) isFoundationCollection

Returns a boolean value that indicates whether the receiving instance is a standard collection.

Returns: YES if the receiving instance is a library collection, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isFoundationCollection: (id) object

Returns a boolean value that indicates whether a given object is an instance of any standard collection class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of a standard collection class, otherwise NO

+ (BOOL) isFoundationCollectionClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any standard collection class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of a standard collection class, otherwise NO

- (BOOL) isFoundationDictionary

Returns a boolean value that indicates whether the receiving instance is a standard dictionary.

Returns: YES if the receiving instance is a standard dictionary, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isFoundationDictionary: (id) object

Returns a boolean value that indicates whether a given object is an instance of any standard dictionary class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of a standard dictionary class, otherwise NO

+ (BOOL) isFoundationDictionaryClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any library dictionary class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of a standard dictionary class, otherwise NO

- (BOOL) isFoundationOrderedSet

Returns a boolean value that indicates whether the receiving instance is a standard ordered set.

Returns: YES if the receiving instance is a standard ordered set, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isFoundationOrderedSet: (id) object

Returns a boolean value that indicates whether a given object is an instance of any standard ordered set class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of a standard ordered set class, otherwise NO

+ (BOOL) isFoundationOrderedSetClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any standard ordered set class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of a standard ordered set class, otherwise NO

- (BOOL) isFoundationSet

Returns a boolean value that indicates whether the receiving instance is a standard set.

Returns: YES if the receiving instance is a standard set, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isFoundationSet: (id) object

Returns a boolean value that indicates whether a given object is an instance of any standard set class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of a standard set class, otherwise NO

+ (BOOL) isFoundationSetClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any standard set class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of a standard set class, otherwise NO

- (BOOL) isLibraryArray

Returns a boolean value that indicates whether the receiving instance is a library array.

Returns: YES if the receiving instance is a library array, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isLibraryArray: (id) object

Returns a boolean value that indicates whether a given object is an instance of any library array class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of a library array class, otherwise NO

+ (BOOL) isLibraryArrayClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any library array class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of a library array class, otherwise NO

- (BOOL) isLibraryCollection

Returns a boolean value that indicates whether the receiving instance is a library collection.

Returns: YES if the receiving instance is a library collection, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isLibraryCollection: (id) object

Returns a boolean value that indicates whether a given object is an instance of any librray collection class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of a library collection class, otherwise NO

+ (BOOL) isLibraryCollectionClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any library collection class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of a library collection class, otherwise NO

- (BOOL) isLibraryDictionary

Returns a boolean value that indicates whether the receiving instance is a library dictionary.

Returns: YES if the receiving instance is a library dictionary, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isLibraryDictionary: (id) object

Returns a boolean value that indicates whether a given object is an instance of any library dictionary class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of a library dictionary class, otherwise NO

+ (BOOL) isLibraryDictionaryClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any library dictionary class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of a library dictionary class, otherwise NO

- (BOOL) isLibraryOrderedSet

Returns a boolean value that indicates whether the receiving instance is a library ordered set.

Returns: YES if the receiving instance is a library ordered set, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isLibraryOrderedSet: (id) object

Returns a boolean value that indicates whether a given object is an instance of any library ordered set class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of a library ordered set class, otherwise NO

+ (BOOL) isLibraryOrderedSetClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any library ordered set class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of a library ordered set class, otherwise NO

- (BOOL) isLibrarySet

Returns a boolean value that indicates whether the receiving instance is a library set.

Returns: YES if the receiving instance is a library set, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isLibrarySet: (id) object

Returns a boolean value that indicates whether a given object is an instance of any library set class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of a library set class, otherwise NO

+ (BOOL) isLibrarySetClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any library set class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of a library set class, otherwise NO

- (BOOL) isList

Returns a boolean value that indicates whether the receiving instance is a list of any supported type.

Returns: YES if the receiving instance is a list, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isList: (id) object

Returns a boolean value that indicates whether a given object is an instance of any list class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of a list class, otherwise NO

+ (BOOL) isListClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any list class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of a list class, otherwise NO

- (BOOL) isOrderedSet

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

Returns: YES if the receiving instance is an orderder set, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isOrderedSet: (id) object

Returns a boolean value that indicates whether a given object is an instance of any ordered set class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of an ordered set class, otherwise NO

+ (BOOL) isOrderedSetClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any ordered set class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of an ordered set class, otherwise NO

- (BOOL) isQueue

Returns a boolean value that indicates whether the receiving instance is a queue.

Returns: YES if the receiving instance is a queue, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isQueue: (id) object

Returns a boolean value that indicates whether a given object is an instance of any queue class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of a queue class, otherwise NO

+ (BOOL) isQueueClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any queue class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of a queue class, otherwise NO

- (BOOL) isSet

Returns a boolean value that indicates whether the receiving instance is a set of any supported type.

Returns: YES if the receiving instance is a set, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isSet: (id) object

Returns a boolean value that indicates whether a given object is an instance of any set class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of a set class, otherwise NO

+ (BOOL) isSetClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any set class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of a set class, otherwise NO

- (BOOL) isSortable

Returns a boolean value that indicates whether the receiving instance is a sortable collection of any supported type.

Returns: YES if the receiving instance is a sortable collection, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isSortable: (id) object

Returns a boolean value that indicates whether a given object is an instance of any sortable collection class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of a sortable collection class, otherwise NO

+ (BOOL) isSortableClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any sortable collection class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of a sortable collection class, otherwise NO

- (BOOL) isStack

Returns a boolean value that indicates whether the receiving instance is a stack.

Returns: YES if the receiving instance is a stack, otherwise NO

Reimplemented from <SCCollection>.

+ (BOOL) isStack: (id) object

Returns a boolean value that indicates whether a given object is an instance of any stack class.

Parameters

object - tested object

Returns: YES if the specified object is an instance of a stack class, otherwise NO

+ (BOOL) isStackClass: (NSString *) name

Returns a boolean value that indicates whether a given string is a name of any stack class.

Parameters

name	- tested string

Returns: YES if the specified string is a name of a stack class, otherwise NO

- (SCOrderedSet *) orderedSet

Returns an ordered set with the all objects from the receiving collection.

Returns: Ordered set with objects

Reimplemented from <SCCollection>.

Reimplemented in SCOrderedSet.

- (SCQueue *) queue

Returns a queue with the all objects from the receiving collection.

Returns: Queue with objects

Reimplemented from <SCCollection>.

Reimplemented in SCQueue.

- (void) removeAllObjects

Removes all objects from the receiving collection.

Exceptions

SCCollectionException - collection error detected

Reimplemented from <SCMutableCollection>.

- (void) removeBool: (BOOL) value

Removes from the receiving collection the all occurrences of the specified boolean value.

Parameters

value - removed value

Exceptions

SCCollectionException - collection error detected

- (void) removeByte: (SCByte) value

Removes from the receiving collection the all occurrences of the specified signed 8-bit integer value.

Parameters

value - removed value

Exceptions

SCCollectionException - collection error detected

- (void) removeChar: (char) value

Removes from the receiving collection the all occurrences of the specified character.

Parameters

value - removed character

Exceptions

SCCollectionException - collection error detected

- (void) removeCharString: (const char *) string

Removes from the receiving collection the all occurrences of the specified character string.

Parameters

string - removed character string

Exceptions

SCCollectionException - collection error detected

- (void) removeCollection: (id) collection

Removes from the receiving collection objects that are present in the specified collection of any supported type.

Parameters

collection - collection with the removed objects

Exceptions

SCCollectionException - collection error detected

Reimplemented from <SCMutableCollection>.

- (void) removeDouble: (SCDouble) value

Removed from the receiving collection the all occurrences of the specified double value.

Parameters

value - removed value

Exceptions

SCCollectionException - collection error detected

- (void) removeFloat: (SCFloat) value

Removes from the receiving collection the all occurrences of the specified float value.

Parameters

value - removed value

Exceptions

SCCollectionException - collection error detected

- (void) removeInteger: (SCInteger) value

Removes from the receiving collection the all occurrences of the specified signed 32-bit integer value.

Parameters

value - removed value

Exceptions

SCCollectionException - collection error detected

- (void) removeLong: (SCLong) value

Removes from the receiving collection the all occurrences of the specified signed 64-bit integer value.

Parameters

value - removed value

Exceptions

SCCollectionException - collection error detected

- (void) removeObject: (id) object

Removes from the receiving collection the all occurrences of the specified object.

Parameters

object - removed object

Exceptions

SCCollectionException - collection error detected

Reimplemented from <SCMutableCollection>.

- (void) removeObjects:	(id)	object
,		NS_REQUIRES_NIL_TERMINATION

Removes from the receiving collection the all occurrences of the objects from the specified nil terminated list.

Parameters

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

Exceptions

SCCollectionException - collection error detected

Reimplemented from <SCMutableCollection>.

- (void) removeObjectsWithClass: (Class) oclass

Removes from the receiving collection all objects of the specified class.

Parameters

oclass - class of removed objects

Exceptions

SCCollectionException - collection error detected

Reimplemented from <SCMutableCollection>.

- (void) removeObjectsWithClassName: (NSString *) name

Removes from the receiving collection all objects of the class with the specified name.

Parameters

name	- named of removed objects class

Exceptions

SCCollectionException - collection error detected

Reimplemented from <SCMutableCollection>.

- (void) removeShort: (SCShort) value

Removes from the receiving collection the all occurrences of the specified signed 16-bit integer value.

Parameters

value - removed value

Exceptions

SCCollectionException - collection error detected

- (void) removeUByte: (SCUByte) value

Removes from the receiving collection the all occurrences of the specified unsigned 8-bit integer value.

Parameters

value - removed value

Exceptions

SCCollectionException - collection error detected

- (void) removeUInteger: (SCUInteger) value

Removes from the receiving collection the all occurrences of the specified unsigned 32-bit integer value.

Parameters

value - removed value

Exceptions

SCCollectionException - collection error detected

- (void) removeULong: (SCULong) value

Removes from the receiving collection the all occurrences of the specified unsigned 64-bit integer value.

Parameters

value - removed value

Exceptions

SCCollectionException - collection error detected

- (void) removeUnichar: (unichar) value

Removes from the receiving collection the all occurrences of the specified character.

Parameters

value - removed character

Exceptions

SCCollectionException - collection error detected

- (void) removeUShort: (SCUShort) value

Removes from the receiving collection the all occurrences of the specified unsigned 16-bit integer value.

Parameters

value - removed value

Exceptions

SCCollectionException - collection error detected

- (void) reverseEnumerate

Tells the instance delegate object for each object in the receiving collection, in reverse order.

- (void) reverseEnumerateWithDelegate: (id<SCCollectionDelegate>) delegate

Tells the specified delegate object for each object in the receiving collection, in reverse order.

Parameters

delegate - delegate object

- (SCSet *) set

Returns a set with the all objects from the receiving collection.

Returns: Set with objects

Reimplemented from <SCCollection>.

Reimplemented in SCSet.

- (void) setCollection: (id) collection

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

Parameters

collection - existing source collection

Exceptions

SCCollectionException - collection error detected

Reimplemented from <SCMutableCollection>.

- (void) setObject: (id) object

Replaces the content of the receiving collection by using the specified existing object.

Parameters

object - existing source object

Exceptions

SCCollectionException - collection error detected

Reimplemented from <SCMutableCollection>.

- (void) setObjects:	(id)	object
,		NS_REQUIRES_NIL_TERMINATION

Replaces the content of the receiving collection by using the objects from the specified nil terminated list.

Parameters

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

Exceptions

SCCollectionException - collection error detected

Reimplemented from <SCMutableCollection>.

- (SCStack *) stack

Returns a stack with the all objects from the receiving collection.

Returns: Stack with objects

Reimplemented from <SCCollection>.

Reimplemented in SCStack.

- (SCUnidirectionalList *) unidirectionalList

Returns an unidirectional list with the all objects from the receiving collection.

Returns: Unidirectional list with objects

Reimplemented from <SCCollection>.

Property Documentation

- (SCULong) count

readnonatomicassign

Number of objects within the collection

- (id< SCCollectionDelegate >) delegate

readwritenonatomicassign

Collection delegate object

- (NSString *) description

readnonatomicretain

Collection description

- (BOOL) empty

readnonatomicassign

Determines whether the collection is empty or contains at least one object.

- (NSString *) name

readwritenonatomicretain

Collection instance name

- (NSEnumerator *) objectEnumerator

readnonatomicretain

Enumerator object that lets you access each object in the collection

- (BOOL) readOnly

readwritenonatomicassign

Determines whether the collection is in read only mode.

- (NSEnumerator *) reverseObjectEnumerator

readnonatomicretain

Enumerator object that lets you access each object in the collection, in reverse order

- (NSString *) typeName

readnonatomicretain

Collection type name

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

SCCollection.h
SCCollection.m

Instance Properties

Initializing Collections

Copying Collections

Comparing Collections

Objects Enumerators

Converting Collections

Adding Objects

Removing Objects

Finding Objects in a Collection

Detecting Collection Type

Additional Inherited Members

Detailed Description

Method Documentation

Property Documentation