Abstract collections class.
More...
#import <SCCollection.h>
Abstract collections class.
- SDK
- macOS 10.6+, iOS 7.0+, GNUstep
- Since
- version 1.1.3
Contains the declaration of all collection mandatory methods.@ Class instances can thrown the following exceptions:
Adds into the receiving collection the objects from the specified existing collection of any supported type.
- Parameters
-
collection | - existing source collection |
- Exceptions
-
Reimplemented from <SCMutableCollection>.
Adds into the receiving collection the specified existing object.
- Parameters
-
object | - the added existing object |
- Exceptions
-
Reimplemented from <SCMutableCollection>.
- (void) addObjects: |
|
(id<SCCollectioning>) |
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
-
Reimplemented from <SCMutableCollection>.
- (BOOL) containsAnyObject: |
|
(id<SCCollectioning>) |
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<SCCollection>) |
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>.
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>.
Returns a boolean value that indicates whether an equivalent of a given object is present in the receiving collection.
- Parameters
-
object | - the desired object |
- Returns
- YES if a given object is present in the receiving collection, otherwise NO
Reimplemented from <SCCollection>.
- (BOOL) containsObjects: |
|
(id<SCCollectioning>) |
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>.
- (NSUInteger) countByEnumeratingWithState: |
|
(NSFastEnumerationState *) |
state |
objects: |
|
(id *) |
objects |
count: |
|
(NSUInteger) |
count |
|
|
| |
Returns by reference a C array of objects over which the sender should iterate, and as the return value the number of objects in the array.
- Parameters
-
state | - context information that is used in the enumeration to, in addition to other possibilities, ensure that the collection has not been mutated |
objects | - a C array of objects over which the sender is to iterate |
count | - the maximum number of objects to return in a C array |
- Returns
- The number of objects returned in a C array or 0 when the iteration is finished
- Since
- version 1.2.5
Reimplemented from <SCCollection>.
Tells the instance delegate object for each object in the receiving collection.
Tells the specified delegate object for each object in the receiving collection.
- Parameters
-
delegate | - delegate object |
- (instancetype) initWithCollection: |
|
(id<SCCollection>) |
collection |
|
- (instancetype) initWithName: |
|
(NSString *) |
name |
|
+ (BOOL) isArray: |
|
(id) |
object |
|
Returns a boolean value that indicates whether a given object is an instance of any array class.
- Parameters
-
- 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
-
- Returns
- YES if the specified string is a name of an array class, otherwise NO
+ (BOOL) isCollection: |
|
(id) |
object |
|
Returns a boolean value that indicates whether a given object is an instance of any collection class.
- Parameters
-
- 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
-
- Returns
- YES if the specified string is a name of a collection class, otherwise NO
+ (BOOL) isDictionary: |
|
(id) |
object |
|
Returns a boolean value that indicates whether a given object is an instance of any dictionary class.
- Parameters
-
- 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
-
- 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 | - the object with which to compare the receiving collection |
- Returns
- YES if the object is equals to the receiving collection, otherwise NO
Reimplemented from SCObject.
Returns a boolean value that indicates whether the contents of the receiving collection is equals to the contents of another given collection.
- Parameters
-
collection | - the collection with which to compare the receiving collection |
- Returns
- YES if the contents of other collection is equals to the contents collection, 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
-
- 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
-
- Returns
- YES if the specified string is a name of a standard array class, otherwise NO
+ (BOOL) isFoundationCollection: |
|
(id) |
object |
|
Returns a boolean value that indicates whether a given object is an instance of any standard collection class.
- Parameters
-
- 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
-
- Returns
- YES if the specified string is a name of a standard collection class, otherwise NO
+ (BOOL) isFoundationDictionary: |
|
(id) |
object |
|
Returns a boolean value that indicates whether a given object is an instance of any standard dictionary class.
- Parameters
-
- 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
-
- Returns
- YES if the specified string is a name of a standard dictionary class, otherwise NO
+ (BOOL) isFoundationOrderedSet: |
|
(id) |
object |
|
Returns a boolean value that indicates whether a given object is an instance of any standard ordered set class.
- Parameters
-
- 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
-
- Returns
- YES if the specified string is a name of a standard ordered set class, otherwise NO
+ (BOOL) isFoundationSet: |
|
(id) |
object |
|
Returns a boolean value that indicates whether a given object is an instance of any standard set class.
- Parameters
-
- 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
-
- Returns
- YES if the specified string is a name of a standard set class, otherwise NO
+ (BOOL) isLibraryArray: |
|
(id) |
object |
|
Returns a boolean value that indicates whether a given object is an instance of any library array class.
- Parameters
-
- 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
-
- Returns
- YES if the specified string is a name of a library array class, otherwise NO
+ (BOOL) isLibraryCollection: |
|
(id) |
object |
|
Returns a boolean value that indicates whether a given object is an instance of any librray collection class.
- Parameters
-
- 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
-
- Returns
- YES if the specified string is a name of a library collection class, otherwise NO
+ (BOOL) isLibraryDictionary: |
|
(id) |
object |
|
Returns a boolean value that indicates whether a given object is an instance of any library dictionary class.
- Parameters
-
- 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
-
- Returns
- YES if the specified string is a name of a library dictionary class, otherwise NO
+ (BOOL) isLibraryOrderedSet: |
|
(id) |
object |
|
Returns a boolean value that indicates whether a given object is an instance of any library ordered set class.
- Parameters
-
- 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
-
- Returns
- YES if the specified string is a name of a library ordered set class, otherwise NO
+ (BOOL) isLibrarySet: |
|
(id) |
object |
|
Returns a boolean value that indicates whether a given object is an instance of any library set class.
- Parameters
-
- 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
-
- Returns
- YES if the specified string is a name of a library set class, otherwise NO
+ (BOOL) isList: |
|
(id) |
object |
|
Returns a boolean value that indicates whether a given object is an instance of any list class.
- Parameters
-
- 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
-
- Returns
- YES if the specified string is a name of a list class, otherwise NO
+ (BOOL) isOrderedSet: |
|
(id) |
object |
|
Returns a boolean value that indicates whether a given object is an instance of any ordered set class.
- Parameters
-
- 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
-
- Returns
- YES if the specified string is a name of an ordered set class, otherwise NO
+ (BOOL) isQueue: |
|
(id) |
object |
|
Returns a boolean value that indicates whether a given object is an instance of any queue class.
- Parameters
-
- 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
-
- Returns
- YES if the specified string is a name of a queue class, otherwise NO
+ (BOOL) isSet: |
|
(id) |
object |
|
Returns a boolean value that indicates whether a given object is an instance of any set class.
- Parameters
-
- 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
-
- Returns
- YES if the specified string is a name of a set class, otherwise NO
+ (BOOL) isSortable: |
|
(id) |
object |
|
Returns a boolean value that indicates whether a given object is an instance of any sortable collection class.
- Parameters
-
- 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
-
- Returns
- YES if the specified string is a name of a sortable collection class, otherwise NO
+ (BOOL) isStack: |
|
(id) |
object |
|
Returns a boolean value that indicates whether a given object is an instance of any stack class.
- Parameters
-
- 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
-
- Returns
- YES if the specified string is a name of a stack class, otherwise NO
- (void) removeAllObjects |
|
|
|
Removes from the receiving collection objects that are present in the specified collection of any supported type.
- Parameters
-
collection | - the collection with the removed objects |
- Exceptions
-
Reimplemented from <SCMutableCollection>.
Removes from the receiving collection the all occurrences of the specified object.
- Parameters
-
object | - the removed object |
- Exceptions
-
Reimplemented from <SCMutableCollection>.
- (void) removeObjects: |
|
(id<SCCollectioning>) |
object |
, |
|
|
NS_REQUIRES_NIL_TERMINATION |
|
|
| |
Removes from the receiving collection the all occurrences of the objects from the specified nil terminated list.
- Parameters
-
object | - the first removed object |
... | - the other removed objects |
NS_REQUIRES_NIL_TERMINATION | - the mandatory nil pointer |
- Exceptions
-
Reimplemented from <SCMutableCollection>.
- (void) removeObjectsWithClass: |
|
(Class) |
oclass |
|
Removes from the receiving collection all objects of the specified class.
- Parameters
-
oclass | - the class of removed objects |
- Exceptions
-
Reimplemented from <SCMutableCollection>.
- (void) removeObjectsWithClassName: |
|
(NSString *) |
name |
|
Removes from the receiving collection all objects of the class with the specified name.
- Parameters
-
name | - the name of removed objects class |
- Exceptions
-
Reimplemented from <SCMutableCollection>.
- (void) reverseEnumerate |
|
|
|
Tells the instance delegate object for each object in the receiving collection, in reverse order.
Tells the specified delegate object for each object in the receiving collection, in reverse order.
- Parameters
-
delegate | - delegate object |
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
-
Reimplemented from <SCMutableCollection>.
Replaces the content of the receiving collection by using the specified existing object.
- Parameters
-
object | - existing source object |
- Exceptions
-
Reimplemented from <SCMutableCollection>.
- (void) setObjects: |
|
(id<SCCollectioning>) |
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
-
Reimplemented from <SCMutableCollection>.
Array with the all collection objects
Bidirectional list with the all collection objects
Number of objects within the collection
Collection delegate object
Dictionary with the all collection objects
Determines whether the collection is empty or contains at least one object
- (NSArray *) foundationArray |
|
readnonatomicassign |
Class NSArray instance with the all collection objects
- (NSDictionary *) foundationDictionary |
|
readnonatomicassign |
Class NSDictionary instance with the all collection objects
- (NSOrderedSet *) foundationOrderedSet |
|
readnonatomicassign |
Class NSOrderedSet instance with the all collection objects
- (NSSet *) foundationSet |
|
readnonatomicassign |
Class NSSet instance with the all collection objects
A boolean value that indicates whether a receiving instance is an array of any supported type
A boolean value that indicates whether a receiving instance is a collection of any supported type
A boolean value that indicates whether a receiving instance is a dictionary of any supported type
- (BOOL) isFoundationArray |
|
readnonatomicassign |
A boolean value that indicates whether a receiving instance is a standard array (instances of the classes NSArray and NSMutableArray)
- (BOOL) isFoundationCollection |
|
readnonatomicassign |
A boolean value that indicates whether a receiving instance is a standard Objective-C collection
- (BOOL) isFoundationDictionary |
|
readnonatomicassign |
- (BOOL) isFoundationOrderedSet |
|
readnonatomicassign |
A boolean value that indicates whether a receiving instance is a standard set (instances of the classes NSSet and NSMutableSet)
A boolean value that indicates whether a receiving instance is a library array (class SCArray instance)
- (BOOL) isLibraryCollection |
|
readnonatomicassign |
A boolean value that indicates whether a receiving instance is a library collection
- (BOOL) isLibraryDictionary |
|
readnonatomicassign |
A boolean value that indicates whether a receiving instance is a library dictionary (class SCDictionary instance)
- (BOOL) isLibraryOrderedSet |
|
readnonatomicassign |
A boolean value that indicates whether a receiving instance is a library ordered set (class SCOrderedSet instance)
A boolean value that indicates whether a receiving instance is a library set (class SCSet instance)
A boolean value that indicates whether a receiving instance is an ordered set of any supported type
A boolean value that indicates whether a receiving instance is a queue (class SCQueue instance)
A boolean value that indicates whether a receiving instance is a set of any supported type
A boolean value that indicates whether a receiving instance is a sortable collection (array or ordered set of any supported type)
A boolean value that indicates whether a receiving instance is a stack (class SCStack instance)
- (NSEnumerator *) objectEnumerator |
|
readnonatomicassign |
Enumerator object that lets you access each object in the collection
Ordered set with the all collection objects
Queue with the all collection objects
Determines whether the collection is in read only mode
- (NSEnumerator *) reverseObjectEnumerator |
|
readnonatomicassign |
Enumerator object that lets you access each object in the collection, in reverse order
Set with the all collection objects
Stack with the all collection objects
Unidirectional list with the all collection objects
The documentation for this class was generated from the following files: