Abstract parent class of library collection classes. More...

#import <SCCollection.h>

Inheritance diagram for SCCollection:

Public Member Functions
Querying Collection Properties
(SCCollectionType)	- type
(NSString *)	- typeName
(NSString *)	- collectionName
(SCULong)	- count
(BOOL)	- isRandomAccess
(BOOL)	- isIndexed
(BOOL)	- isReadOnly
(SCULong)	- capacity
(BOOL)	- isUnlimited
(SCLong)	- freeCount
(BOOL)	- freeItemsAvailable
(BOOL)	- isEmpty
(id< SCCollectionDelegate >)	- delegate
Setting Collection Properties
(void)	- setCollectionName:
(void)	- setReadOnly:
(void)	- setCapacity:
(void)	- setDelegate:
Setting and Copying Collections
(void)	- copyFromCollection:
(void)	- copyFromObject:
(void)	- copyFromObjects:
Find Objects in 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)	- containsObjectsFromCollection:
(BOOL)	- containsAnyObject:
(BOOL)	- containsAnyObjectFromCollection:
Comparing Collections
(BOOL)	- isEqualToCollection:
(BOOL)	- isEqualToContentsOfCollection:
(BOOL)	- isEqual:
Enumerating Collections
(NSEnumerator *)	- objectEnumerator
(NSEnumerator *)	- reverseObjectEnumerator
(void)	- enumerateWithDelegate:
(void)	- enumerate
(void)	- reverseEnumerateWithDelegate:
(void)	- reverseEnumerate
Describing Collection
(NSString *)	- description
Converting Collection
(SCArray *)	- array
(SCSet *)	- set
(SCStack *)	- stack
(SCQueue *)	- queue
(SCDictionary *)	- dictionary
(SCUnidirectionalList *)	- unidirectionalList
(SCBidirectionalList *)	- bidirectionalList
(NSArray *)	- foundationArray
(NSSet *)	- foundationSet
(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)	- addObjectsFromCollection:
Removing Objects
(void)	- removeAllObjects
(void)	- removeObjectsWithClass:
(void)	- removeObjectsWithClassName:
Static Public Member Functions
Additional methods
(SCULong)	+ countOfCollection:
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:

Detailed Description

Abstract parent class of library collection classes.

Class contains the declaration of all common collection methods.
Class was introduced in version 1.1.3.

Class declares the following properties:

SCCollectionType type - collection type (read only)
NSString* typeName - collection type name (read only)
NSString* collectionName - collection name
SCULong count - items count (read only)
BOOL isRandomAccess - random access support (read only)
BOOL isIndexed - indexing support (read only)
BOOL isReadOnly - read only flag
SCULong capacity - collection capacity (maximum size)
BOOL isUnlimited - unlimited collection size flag (read only)
SCLong freeCount - free items count (read only)
BOOL freeItemsAvailable - free items availability flag (read only)
BOOL isEmpty - empty collection flag (read only)
NSString* description - string representation of the queue (read only)
SCCollectionDelegate *delegate - collection events delegate object

Member Function Documentation

- (void) addBool: (BOOL) boolean

Adds into the receiving collection the specified boolean variable.

Parameters:

boolean - added variable

Exceptions:

SCCollectionException - collection error detected

- (void) addByte: (SCByte) byte

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

Parameters:

byte	- added variable

Exceptions:

SCCollectionException - collection error detected

- (void) addChar: (char) chr

Adds into the receiving collection the specified char variable.

Parameters:

chr	- added variable

Exceptions:

SCCollectionException - collection error detected

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

Adds into the receiving collection the specified char string variable.

Parameters:

string - added variable

Exceptions:

SCCollectionException - collection error detected

- (void) addDouble: (SCDouble) dbl

Adds into the receiving collection the specified double precision float variable.

Parameters:

dbl	- added variable

Exceptions:

SCCollectionException - collection error detected

- (void) addFloat: (SCFloat) flt

Adds into the receiving collection the specified single precision float variable.

Parameters:

flt	- added variable

Exceptions:

SCCollectionException - collection error detected

- (void) addInteger: (SCInteger) integer

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

Parameters:

integer - added variable

Exceptions:

SCCollectionException - collection error detected

- (void) addLong: (SCLong) longint

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

Parameters:

longint - added variable

Exceptions:

SCCollectionException - collection error detected

- (void) addObject: (id) object

Adds into the receiving collection the specified object.

Parameters:

object - added object

Exceptions:

SCCollectionException - collection error detected

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

Adds into the collection the specified objects.

Parameters:

object	- first object
...	- other objects with nil terminate

Exceptions:

SCCollectionException - exception error detected

- (void) addObjectsFromCollection: (id) collection

Adds into the receiving collection the objects from the specified existing collection.

Parameters:

collection - existing source collection

Exceptions:

SCCollectionException - collection error detected

- (void) addShort: (SCShort) sht

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

Parameters:

sht	- added variable

Exceptions:

SCCollectionException - collection error detected

- (void) addUByte: (SCUByte) byte

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

Parameters:

byte	- added variable

Exceptions:

SCCollectionException - collection error detected

- (void) addUInteger: (SCUInteger) integer

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

Parameters:

integer - added variable

Exceptions:

SCCollectionException - collection error detected

- (void) addULong: (SCULong) longint

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

Parameters:

longint - added variable

Exceptions:

SCCollectionException - collection error detected

- (void) addUnichar: (unichar) chr

Adds into the receiving collection the specified unichar variable.

Parameters:

chr	- added variable

Exceptions:

SCCollectionException - collection error detected

- (void) addUShort: (SCUShort) sht

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

Parameters:

sht	- added variable

Exceptions:

SCCollectionException - collection error detected

- (SCArray *) array

Returns the array with the copy of all receiving collection objects.

Returns:: Array with objects

Reimplemented in SCArray.

- (SCBidirectionalList *) bidirectionalList

Returns the bidirectional list with the copy of all receiving collection objects.

Returns:: Bidirectional list with objects

- (SCULong) capacity

Returns the collection max size.

Returns:: Max size

- (NSString *) collectionName

Returns the collection name.

Returns:: Collection name

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

Returns a Boolean value that indicates whether the receiver's collection contains at least one object from the specified nil terminated list.

Parameters:

object	- fist desired object
...	- other desired objects

Returns:: YES if at least one of given objects are present in the collection, otherwise NO

- (BOOL) containsAnyObjectFromCollection: (id) collection

Returns a Boolean value that indicates whether the receiver's collection contains at least one object from the specified collection.

Parameters:

collection - source collection

Returns:: YES if at least one of given objects are present in the collection, otherwise NO

Exceptions:

SCCollectionException - collection error detected

- (BOOL) containsBool: (BOOL) boolean

Returns a Boolean value that indicates whether a equivalent of the given boolean value is present in the receiver's collection.

Parameters:

boolean - desired value

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

- (BOOL) containsByte: (SCByte) byte

Returns a Boolean value that indicates whether a equivalent of the given signed 8-bit integer value is present in the receiver's collection.

Parameters:

byte	- desired value

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

- (BOOL) containsChar: (char) chr

Returns a Boolean value that indicates whether a equivalent of the given char value is present in the receiver's collection.

Parameters:

chr	- desired value

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

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

Returns a Boolean value that indicates whether a equivalent of the given char string value is present in the receiver's collection.

Parameters:

string - desired value

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

- (BOOL) containsDouble: (SCDouble) dbl

Returns a Boolean value that indicates whether a equivalent of the given double precision float value is present in the receiver's collection.

Parameters:

dbl	- desired value

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

- (BOOL) containsFloat: (SCFloat) flt

Returns a Boolean value that indicates whether a equivalent of the given single precision float value is present in the receiver's collection.

Parameters:

flt	- desired value

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

- (BOOL) containsInteger: (SCInteger) integer

Returns a Boolean value that indicates whether a equivalent of the given signed 32-bit integer value is present in the receiver's collection.

Parameters:

integer - desired value

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

- (BOOL) containsLong: (SCLong) longint

Returns a Boolean value that indicates whether a equivalent of the given signed 64-bit integer value is present in the receiver's collection.

Parameters:

longint - desired value

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

- (BOOL) containsObject: (id) object

Returns a Boolean value that indicates whether a equivalent of the given object is present in the receiver's collection.

Parameters:

object - desired object

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

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

Returns a Boolean value that indicates whether the receiver's collection contains the all objects from the specified nil terminated list.

Parameters:

object	- fist desired object
...	- other desired objects

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

- (BOOL) containsObjectsFromCollection: (id) collection

Returns a Boolean value that indicates whether the receiver's collection contains the all objects from the specified collection.

Parameters:

collection - source collection

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

Exceptions:

SCCollectionException - collection error detected

- (BOOL) containsShort: (SCShort) sht

Returns a Boolean value that indicates whether a equivalent of the given signed 16-bit integer value is present in the receiver's collection.

Parameters:

sht	- desired value

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

- (BOOL) containsUByte: (SCUByte) byte

Returns a Boolean value that indicates whether a equivalent of the given unsigned 8-bit integer value is present in the receiver's collection.

Parameters:

byte	- desired value

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

- (BOOL) containsUInteger: (SCUInteger) integer

Returns a Boolean value that indicates whether a equivalent of the given unsigned 32-bit integer value is present in the receiver's collection.

Parameters:

integer - desired value

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

- (BOOL) containsULong: (SCULong) longint

Returns a Boolean value that indicates whether a equivalent of the given unsigned 64-bit integer value is present in the receiver's collection.

Parameters:

longint - desired value

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

- (BOOL) containsUnichar: (unichar) chr

Returns a Boolean value that indicates whether a equivalent of the given unichar value is present in the receiver's collection.

Parameters:

chr	- desired value

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

- (BOOL) containsUShort: (SCUShort) sht

Returns a Boolean value that indicates whether a equivalent of the given unsigned 16-bit integer value is present in the receiver's collection.

Parameters:

sht	- desired value

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

- (void) copyFromCollection: (id) collection

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

Parameters:

collection - existing collection

Exceptions:

SCCollectionException - collection error detected

- (void) copyFromObject: (id) object

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

Parameters:

object - existing source object

Exceptions:

SCCollectionException - collection error detected

- (void) copyFromObjects:	(id)	object
,		...

Replaces the receiver's collection content by the items from the specified existing objects.

Parameters:

object	- first source object
...	- other objects nil terminated list

Exceptions:

SCCollectionException - collection error detected

- (SCULong) count

Returns the count of collection items.

Returns:: Collection items count

+ (SCULong) countOfCollection: (id) collection

Returns the count of objects within the specified collection.

Parameters:

collection - source collection

Returns:: Count of objects

Exceptions:

SCCollectionException - collection error detected

- (id< SCCollectionDelegate >) delegate

Returns the collection events delegate object.

Returns:: Delegate object

- (NSString *) description

Returns the string with the receiving collection description.

Returns:: Collection description string

- (SCDictionary *) dictionary

Returns the dictionary with the copy of all receiving collection objects.

Returns:: Dictionary with objects

Reimplemented in SCDictionary.

- (void) enumerate

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

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

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

Parameters:

delegate - delegate object

- (NSArray *) foundationArray

Returns the foundation array with the copy of all receiving collection objects.

Returns:: Foundation array with objects

- (NSDictionary *) foundationDictionary

Returns the foundation dictionary with the copy of all receiving collection objects.

Returns:: Foundation dictionary with objects

- (NSSet *) foundationSet

Returns the foundation set with the copy of all receiving collection objects.

Returns:: Foundation set with objects

- (SCLong) freeCount

Returns the collection free items count.

Returns:: Free items count

- (BOOL) freeItemsAvailable

Determines whether the receiver's collection have the available free space for adding items.

Returns:: YES if the collection have the available free space, otherwise NO

- (BOOL) isArray

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

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

+ (BOOL) isArray: (id) object

Returns a boolean value that indicates whether a given instance is an array.

Parameters:

object - tested instance

Returns:: YES if the specified instance is an array of any type, otherwise NO

+ (BOOL) isArrayClass: (NSString *) name

Returns a boolean value that indicates whether a given class name is an array class name.

Parameters:

name	- tested class name

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

- (BOOL) isCollection

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

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

+ (BOOL) isCollection: (id) object

Returns a boolean value that indicates whether a given instance is a collection.

Parameters:

object - tested instance

Returns:: YES if the specified instance is a collection of any type, otherwise NO

+ (BOOL) isCollectionClass: (NSString *) name

Returns a boolean value that indicates whether a given class name is a collection class name.

Parameters:

name	- tested class name

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

- (BOOL) isDictionary

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

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

+ (BOOL) isDictionary: (id) object

Returns a boolean value that indicates whether a given instance is a dictionary.

Parameters:

object - tested instance

Returns:: YES if the specified instance is a dictionary of any type, otherwise NO

+ (BOOL) isDictionaryClass: (NSString *) name

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

Parameters:

name	- tested class name

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

- (BOOL) isEmpty

Determines whether the receiver's collection is empty or contains at least one item.

Returns:: YES if the collection is empty, otherwise NO

- (BOOL) isEqual: (id) object

Returns a boolean value that indicates whether the receiver and a given object are equal.

Parameters:

object - object to be compared to the receiver

Returns:: YES if the objects are equal, otherwise NO

Reimplemented from SCObject.

- (BOOL) isEqualToCollection: (id) collection

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

Parameters:

collection - collection with which to compare the receiving collection

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

Exceptions:

SCCollectionException - collection error detected

- (BOOL) isEqualToContentsOfCollection: (id) collection

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

Parameters:

collection - collection with which to compare the receiving collection

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

Exceptions:

SCCollectionException - collection error detected

- (BOOL) isFoundationArray

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

Returns:: YES if the receiving instance is a foundation array of any type, otherwise NO

+ (BOOL) isFoundationArray: (id) object

Returns a boolean value that indicates whether a given instance is a foundation array.

Parameters:

object - tested instance

Returns:: YES if the specified instance is a foundation array of any type, otherwise NO

+ (BOOL) isFoundationArrayClass: (NSString *) name

Returns a boolean value that indicates whether a given class name is foundation array class name.

Parameters:

name	- tested class name

Returns:: YES if the specified class name is a name of any foundation array class, otherwise NO

- (BOOL) isFoundationCollection

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

Returns:: YES if the receiving instance is a foundation collection of any type, otherwise NO

+ (BOOL) isFoundationCollection: (id) object

Returns a boolean value that indicates whether a given instance is a foundation collection.

Parameters:

object - tested instance

Returns:: YES if the specified instance is a collection of any foundation type, otherwise NO

+ (BOOL) isFoundationCollectionClass: (NSString *) name

Returns a boolean value that indicates whether a given class name is a foundation collection class name.

Parameters:

name	- tested class name

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

- (BOOL) isFoundationDictionary

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

Returns:: YES if the receiving instance is a foundation dictionary of any type, otherwise NO

+ (BOOL) isFoundationDictionary: (id) object

Returns a boolean value that indicates whether a given instance is a foundation dictionary.

Parameters:

object - tested instance

Returns:: YES if the specified instance is a foundation dictionary of any type, otherwise NO

+ (BOOL) isFoundationDictionaryClass: (NSString *) name

Returns a boolean value that indicates whether a given class name is a foundation dictionary class name.

Parameters:

name	- tested class name

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

- (BOOL) isFoundationOrderedSet

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

Returns:: YES if the receiving instance is a foundation ordered set of any type, otherwise NO

+ (BOOL) isFoundationOrderedSet: (id) object

Returns a boolean value that indicates whether a given instance is a foundation ordered set.

Parameters:

object - tested instance

Returns:: YES if the specified instance is a foundation ordered set of any type, otherwise NO

+ (BOOL) isFoundationOrderedSetClass: (NSString *) name

Returns a boolean value that indicates whether a given class name is a foundation ordered set class name.

Parameters:

name	- tested class name

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

- (BOOL) isFoundationSet

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

Returns:: YES if the receiving instance is a foundation set of any type, otherwise NO

+ (BOOL) isFoundationSet: (id) object

Returns a boolean value that indicates whether a given instance is a foundation set.

Parameters:

object - tested instance

Returns:: YES if the specified instance is a foundation set of any type, otherwise NO

+ (BOOL) isFoundationSetClass: (NSString *) name

Returns a boolean value that indicates whether a given class name is a foundation set class name.

Parameters:

name	- tested class name

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

- (BOOL) isIndexed

Determines whether the receiver's collection supports indexing of items.

Returns:: YES if the collection supports indexing, otherwise NO

- (BOOL) isLibraryArray

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

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

+ (BOOL) isLibraryArray: (id) object

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

Parameters:

object - tested instance

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

+ (BOOL) isLibraryArrayClass: (NSString *) name

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

Parameters:

name	- tested class name

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

- (BOOL) isLibraryCollection

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

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

+ (BOOL) isLibraryCollection: (id) object

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

Parameters:

object - tested instance

Returns:: YES if the specified instance is a collection of any library type, otherwise NO

+ (BOOL) isLibraryCollectionClass: (NSString *) name

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

Parameters:

name	- tested class name

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

- (BOOL) isLibraryDictionary

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

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

+ (BOOL) isLibraryDictionary: (id) object

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

Parameters:

object - tested instance

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

+ (BOOL) isLibraryDictionaryClass: (NSString *) name

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

Parameters:

name	- tested class name

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

- (BOOL) isLibraryOrderedSet

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

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

+ (BOOL) isLibraryOrderedSet: (id) object

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

Parameters:

object - tested instance

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

+ (BOOL) isLibraryOrderedSetClass: (NSString *) name

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

Parameters:

name	- tested class name

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

- (BOOL) isLibrarySet

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

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

+ (BOOL) isLibrarySet: (id) object

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

Parameters:

object - tested instance

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

+ (BOOL) isLibrarySetClass: (NSString *) name

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

Parameters:

name	- tested class name

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

- (BOOL) isList

Returns a boolean value that indicates whether a receiving instance is a list.

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

+ (BOOL) isList: (id) object

Returns a boolean value that indicates whether a given instance is a list.

Parameters:

object - tested instance

Returns:: YES if the specified instance is a list of any type, otherwise NO

+ (BOOL) isListClass: (NSString *) name

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

Parameters:

name	- tested class name

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

- (BOOL) isOrderedSet

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

Returns:: YES if the receiving instance is an ordered set of any type, otherwise NO

+ (BOOL) isOrderedSet: (id) object

Returns a boolean value that indicates whether a given instance is an ordered set.

Parameters:

object - tested instance

Returns:: YES if the specified instance is an ordered set of any type, otherwise NO

+ (BOOL) isOrderedSetClass: (NSString *) name

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

Parameters:

name	- tested class name

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

- (BOOL) isQueue

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

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

+ (BOOL) isQueue: (id) object

Returns a boolean value that indicates whether a given instance is a queue.

Parameters:

object - tested instance

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

+ (BOOL) isQueueClass: (NSString *) name

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

Parameters:

name	- tested class name

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

- (BOOL) isRandomAccess

Determines whether the receiver's collection supports random acceess to items.

Returns:: YES if the collection supports random access, otherwise NO

- (BOOL) isReadOnly

Determines whether the receiver's collection in read only mode.

Returns:: YES if the collection is read only, otherwise NO

- (BOOL) isSet

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

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

+ (BOOL) isSet: (id) object

Returns a boolean value that indicates whether a given instance is a set.

Parameters:

object - tested instance

Returns:: YES if the specified instance is a set of any type, otherwise NO

+ (BOOL) isSetClass: (NSString *) name

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

Parameters:

name	- tested class name

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

- (BOOL) isSortable

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

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

+ (BOOL) isSortable: (id) object

Returns a boolean value that indicates whether a given instance is a sortable collection.

Parameters:

object - tested istance

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

+ (BOOL) isSortableClass: (NSString *) name

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

Parameters:

name	- tested class name

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

- (BOOL) isStack

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

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

+ (BOOL) isStack: (id) object

Returns a boolean value that indicates whether a given instance is a stack.

Parameters:

object - tested instance

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

+ (BOOL) isStackClass: (NSString *) name

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

Parameters:

name	- tested class name

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

- (BOOL) isUnlimited

Determines whether the receiver's collection have unlimited size.

Returns:: YES if the collection is unlimited, otherwise NO

- (NSEnumerator *) objectEnumerator

Returns an enumerator object that lets you access each object in the collection.

Returns:: Enumerator object

- (SCQueue *) queue

Returns the queue with the copy of all receiving collection objects.

Returns:: Queue with objects

Reimplemented in SCQueue.

- (void) removeAllObjects

Removes all objects from the receiver's collection.

Exceptions:

SCCollectionException - collection error detected

- (void) removeObjectsWithClass: (Class) oclass

Removes from the receiver's collection all objects of the specified class.

Parameters:

oclass - class of removed objects

Exceptions:

SCCollectionException - collection error detected

- (void) removeObjectsWithClassName: (NSString *) name

Removes from the receiver's collection all objects of the specified class name.

Parameters:

name	- class name

Exceptions:

SCCollectionException - collection error detected

- (void) reverseEnumerate

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

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

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

Parameters:

delegate - delegate object

- (NSEnumerator *) reverseObjectEnumerator

Returns an enumerator object that lets you access each object in the collection, in reverse order.

Returns:: Enumerator object

- (SCSet *) set

Returns the set with the copy of all receiving collection objects.

Returns:: Set with objects

Reimplemented in SCSet.

- (void) setCapacity: (SCULong) capacity

Sets the collection max size.

Returns:: Max size

- (void) setCollectionName: (NSString *) name

Sets the collection name.

Parameters:

name	- collection name

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

Sets the collection events delegate objects.

Parameters:

delegate - delegate object

- (void) setReadOnly: (BOOL) flag

Sets the receiver's collection read only mode flag.

Parameters:

flag	- YES for set read only mode, otherwise NO

- (SCStack *) stack

Returns the stack with the copy of all receiving collection objects.

Returns:: Stack with objects

Reimplemented in SCStack.

- (SCCollectionType) type

Returns the collection type.

Returns:: Collection type

- (NSString *) typeName

Returns the collection type name.

Returns:: Collection type name

- (SCUnidirectionalList *) unidirectionalList

Returns the unidirectional list with the copy of all receiving collection objects.

Returns:: Unidirectional list with objects

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

SCCollection.h
SCCollection.m

SCCollection Class Reference

Public Member Functions

Static Public Member Functions

Detecting Collection Type

Detailed Description

Member Function Documentation