<SCMutableCollection> Protocol Reference

Mutable collections protocol. More...

#import <SCCollectionProtocols.h>

Inheritance diagram for <SCMutableCollection>:

Copying Collections
(void)	- setCollection:
(void)	- setObject:
(void)	- setObjects:

Adding Objects
(void)	- addObject:
(void)	- addObjects:
(void)	- addCollection:

Removing Objects
(void)	- removeAllObjects
(void)	- removeObjectsWithClass:
(void)	- removeObjectsWithClassName:
(void)	- removeCollection:
(void)	- removeObject:
(void)	- removeObjects:

Additional Inherited Members
Instance Methods inherited from <SCCollection>
(NSString *)	- name
(void)	- setName:
(SCIndex)	- count
(NSString *)	- description
(BOOL)	- empty
(BOOL)	- readOnly
(instancetype)	- initWithCollection:
(BOOL)	- containsObject:
(BOOL)	- containsObjects:
(BOOL)	- containsCollection:
(BOOL)	- containsAnyObject:
(BOOL)	- containsAnyObjectFromCollection:
(SCArray *)	- array
(SCSet *)	- set
(SCOrderedSet *)	- orderedSet
(SCDictionary *)	- dictionary
(SCStack *)	- stack
(SCQueue *)	- queue
(SCUnidirectionalList *)	- unidirectionalList
(SCBidirectionalList *)	- bidirectionalList
(NSArray *)	- foundationArray
(NSSet *)	- foundationSet
(NSOrderedSet *)	- foundationOrderedSet
(NSDictionary *)	- foundationDictionary
(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
(NSEnumerator *)	- objectEnumerator
(NSEnumerator *)	- reverseObjectEnumerator
Properties inherited from <SCCollection>
NSString *	name
SCIndex	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

Mutable collections protocol.

SDK

macOS 10.6+, iOS 7.0+, GNUstep

Since

version 1.2.0

Declares the mandatory methods that support the changes of the collection content.

Method Documentation

- (void) addCollection:

(id< SCCollection >)

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 in SCCollection, NSMutableArray(SCMutableArray), NSMutableDictionary(SCMutableDictionary), NSMutableOrderedSet(SCMutableOrderedSet), and NSMutableSet(SCMutableSet).

- (void) addObject:

(id< SCCollectioning >)

object

Adds into the receiving collection the specified object.

Parameters

object

- added object

Exceptions

SCCollectionException

- collection error detected

Reimplemented in SCCollection, and NSMutableDictionary(SCMutableDictionary).

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

SCCollectionException

- collection error detected

Reimplemented in SCCollection, NSMutableArray(SCMutableArray), NSMutableDictionary(SCMutableDictionary), NSMutableOrderedSet(SCMutableOrderedSet), and NSMutableSet(SCMutableSet).

- (void) removeAllObjects

Removes all objects from the receiving collection.

Exceptions

SCCollectionException

- collection error detected

Reimplemented in SCCollection.

- (void) removeCollection:

(id< SCCollection >)

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 in SCCollection, NSMutableArray(SCMutableArray), NSMutableDictionary(SCMutableDictionary), NSMutableOrderedSet(SCMutableOrderedSet), and NSMutableSet(SCMutableSet).

- (void) removeObject:

(id< SCCollectioning >)

object

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

Parameters

object

- removed object

Exceptions

SCCollectionException

- collection error detected

Reimplemented in SCCollection, and NSMutableDictionary(SCMutableDictionary).

- (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	- first removed object
...	- other removed objects
NS_REQUIRES_NIL_TERMINATION	- mandatory nil pointer

Exceptions

SCCollectionException

- collection error detected

Reimplemented in SCCollection, NSMutableArray(SCMutableArray), NSMutableDictionary(SCMutableDictionary), NSMutableOrderedSet(SCMutableOrderedSet), and NSMutableSet(SCMutableSet).

- (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 in SCCollection, NSMutableArray(SCMutableArray), NSMutableDictionary(SCMutableDictionary), NSMutableOrderedSet(SCMutableOrderedSet), and NSMutableSet(SCMutableSet).

- (void) removeObjectsWithClassName:

(NSString *)

name

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

Parameters

name	- name of removed objects class

Exceptions

SCCollectionException

- collection error detected

Reimplemented in SCCollection, NSMutableArray(SCMutableArray), NSMutableDictionary(SCMutableDictionary), NSMutableOrderedSet(SCMutableOrderedSet), and NSMutableSet(SCMutableSet).

- (void) setCollection:

(id< SCCollection >)

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 in SCCollection, NSMutableArray(SCMutableArray), NSMutableDictionary(SCMutableDictionary), NSMutableOrderedSet(SCMutableOrderedSet), and NSMutableSet(SCMutableSet).

- (void) setObject:

(id< SCCollectioning >)

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 in SCCollection, NSMutableArray(SCMutableArray), NSMutableDictionary(SCMutableDictionary), NSMutableOrderedSet(SCMutableOrderedSet), and NSMutableSet(SCMutableSet).

- (void) setObjects:		(id< SCCollectioning >)	object
,			NS_REQUIRES_NIL_TERMINATION

Replaces the content of the receiving collection by using 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 in SCCollection, NSMutableArray(SCMutableArray), NSMutableDictionary(SCMutableDictionary), NSMutableOrderedSet(SCMutableOrderedSet), and NSMutableSet(SCMutableSet).

---

The documentation for this protocol was generated from the following file:

• SCCollectionProtocols.h