NSSet(SCSet) Category Reference

Standard class NSSet functionality extending category. More...

#import <NSSet+SCSet.h>

Inheritance diagram for NSSet(SCSet):

Creating Sets
(instancetype)	+ setWithCoder:
(instancetype)	+ setWithContentsOfSerializedFile:
(instancetype)	+ setWithDataDictionary:
(instancetype)	+ setWithDataDictionaryFromFile:
(instancetype)	+ setWithStream:
(instancetype)	+ setWithFileStream:
(instancetype)	+ setWithData:
(instancetype)	+ setWithContentsOfFile:
(instancetype)	+ setWithContentsOfURL:
(instancetype)	+ setWithContentsOfURLString:
(instancetype)	+ setWithCollection:

Initializing Sets
(instancetype)	- initWithCollection:

Protocol SCCollection Implementation
NSString *	name
BOOL	empty
BOOL	readOnly
id< SCCollectionDelegate >	delegate
SCCollectionType	collectionType
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

Finding Objects in a Set
(BOOL)	- containsObjects:
(BOOL)	- containsCollection:
(BOOL)	- containsAnyObject:
(BOOL)	- containsAnyObjectFromCollection:

Converting Sets
SCArray *	array
SCSet *	set
SCOrderedSet *	orderedSet
SCDictionary *	dictionary
SCStack *	stack
SCQueue *	queue
SCUnidirectionalList *	unidirectionalList
SCBidirectionalList *	bidirectionalList
NSArray *	foundationArray
NSSet *	foundationSet
NSOrderedSet *	foundationOrderedSet
NSDictionary *	foundationDictionary

Comparing Sets
(BOOL)	- isEqualToCollection:

Deriving New Sets
(NSSet *)	- setByAddingObjects:
(NSSet *)	- setByAddingArray:
(NSSet *)	- setByAddingSet:
(NSSet *)	- setByAddingCollection:

Additional Inherited Members
Instance Methods inherited from <SCCollection>
(NSUInteger)	- countByEnumeratingWithState:objects:count:
(BOOL)	- containsObject:
Properties inherited from <SCCollection>
NSString *	name
SCIndex	count
BOOL	empty
BOOL	readOnly
id< SCCollectionDelegate >	delegate
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
NSEnumerator *	reverseObjectEnumerator
SCCollectionType	collectionType
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

Standard class NSSet functionality extending category.

SDK

macOS 10.6+, iOS 7.0+, GNUstep

Since

version 1.1.3

Implements the additional methods for add into the standard class NSSet the enhanced functionality.

Method Documentation

- (BOOL) containsAnyObject:		(id<SCCollectioning>)	object
,			NS_REQUIRES_NIL_TERMINATION

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

Parameters

object	- the first object to find within the receiving set
...	- a comma-separated list of additional objects, ending with nil pointer
NS_REQUIRES_NIL_TERMINATION	- the mandatory nil pointer

Returns

YES if the receiving set 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 set contains at least one object from the specified collection of any supported type.

Parameters

collection

- the collection with the required objects

Returns

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

Reimplemented from <SCCollection>.

- (BOOL) containsCollection:

(id<SCCollection>)

collection

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

Parameters

collection

- the collection with the required objects

Returns

YES if the all required objects are present in the receiving set, otherwise NO

Reimplemented from <SCCollection>.

- (BOOL) containsObjects:		(id<SCCollectioning>)	object
,			NS_REQUIRES_NIL_TERMINATION

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

Parameters

object	- the first object to find within the receiving set
...	- a comma-separated list of additional objects, ending with nil pointer
NS_REQUIRES_NIL_TERMINATION	- the mandatory nil pointer

Returns

YES if all objects are present in the receiving set, otherwise NO

Reimplemented from <SCCollection>.

- (instancetype) initWithCollection:

(id<SCCollection>)

collection

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

Parameters

collection

- the source collection

Returns

A newly initialized set

Exceptions

SCCollectionException

- collection error detected

Reimplemented from <SCCollection>.

- (BOOL) isEqualToCollection:

(id<SCCollection>)

collection

Compares the receiving set to the specified collection of any supported type.

Parameters

collection

- a collection

Returns

YES if the contents of the specified collection are equal to the contents of the receiving set, otherwise NO

Exceptions

SCCollectionException

- collection error detected

Reimplemented from <SCCollection>.

- (NSSet *) setByAddingArray:

(NSArray *)

array

Returns the new set formed by adding the objects in a given array to the receiving set.

Parameters

array

- the array of objects to add to the set

Returns

A new set that contains objects from receiving set and a given array

Since

version 1.2.3

- (NSSet *) setByAddingCollection:

(id<SCCollection>)

collection

Returns the new set formed by adding the objects in a given collection of any supported type to the receiving set.

Parameters

collection

- the collection of objects to add to the set

Returns

A new set that contains objects from receiving set and a given collection

Exceptions

SCCollectionException

- collection error detected

Since

version 1.2.3

- (NSSet *) setByAddingObjects:		(id)	object
,			NS_REQUIRES_NIL_TERMINATION

Creates and returns a new set with objects from the receiving set and objects from a given list.

Parameters

object	- the first object to add into the new set
...	- a comma-separated list of additional objects, ending with nil pointer
NS_REQUIRES_NIL_TERMINATION	- the mandatory nil pointer

Returns

A new set with objects from the receiving set and a given list

Since

version 1.2.3

- (NSSet *) setByAddingSet:

(NSSet *)

set

Returns the new set formed by adding the objects in a given set to the receiving set.

Parameters

set	- the set of objects to add to the set

Returns

A new set that contains objects from receiving set and a given set

Since

version 1.2.3

+ (instancetype) setWithCoder:

(NSCoder *)

coder

Returns a set created by using the specified coder.

Parameters

coder

- the source coder

Returns

A created set

+ (instancetype) setWithCollection:

(id<SCCollection>)

collection

Returns a set created by using the specified existing collection of any supported type.

Parameters

collection

- the source collection

Returns

A created set

Exceptions

SCCollectionException

- collection error detected

+ (instancetype) setWithContentsOfFile:

(NSString *)

path

Returns a set created by using the file with the specified path.

Parameters

path	- the path to the source file

Returns

A created set

+ (instancetype) setWithContentsOfSerializedFile:

(NSString *)

path

Returns a set created by using the content of serialized file with the specified path.

Parameters

path	- the path to the source serialized file

Returns

A created set

+ (instancetype) setWithContentsOfURL:

(NSURL *)

url

Returns a set created by using the specified URL.

Parameters

url	- the source URL

Returns

A created set

+ (instancetype) setWithContentsOfURLString:

(NSString *)

urlString

Returns a set created by using the data from the URL with the specified string.

Parameters

urlString

- the string of the source URL

Returns

A created set

+ (instancetype) setWithData:

(NSData *)

data

Returns a set created by using the specified data object.

Parameters

data	- the source data object

Returns

A created set

+ (instancetype) setWithDataDictionary:

(NSDictionary *)

dictionary

Returns a set created by using the specified data dictionary.

Parameters

dictionary

- the source data dictionary

Returns

A created set

+ (instancetype) setWithDataDictionaryFromFile:

(NSString *)

path

Returns a set created by using the data dictionary from the specified file.

Parameters

path	- the path to the source file with the data dictionary

Returns

A created set

+ (instancetype) setWithFileStream:

(NSString *)

path

Returns a set created by using the data from the file stream with the specified path.

Parameters

path	- the path to the source file stream

Returns

A created set

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

+ (instancetype) setWithStream:

(SCStream *)

stream

Returns a set created by using the data from the specified stream.

Parameters

stream

- the source stream

Returns

A created set

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

Property Documentation

- (SCArray *) array

readnonatomicassign

An array with the all objects from the receiving set

- (SCBidirectionalList *) bidirectionalList

readnonatomicassign

A bidirectional list with the all objects from the receiving set

- (SCCollectionType) collectionType

readnonatomicassign

A type of the collection

- (id) delegate

readnonatomicretain

A set delegate object

- (SCDictionary *) dictionary

readnonatomicassign

A dictionary with the all objects from the receiving set

- (BOOL) empty

readnonatomicassign

Determines whether the set is empty or contains at least one object

- (NSArray *) foundationArray

readnonatomicassign

A foundation array with the all objects from the receiving set

- (NSDictionary *) foundationDictionary

readnonatomicassign

A foundation dictionary with all objects from the receiving set

- (NSOrderedSet *) foundationOrderedSet

readnonatomicassign

A foundation ordered set with the all objects from the receiving set

- (NSSet *) foundationSet

readnonatomicassign

A foundation set with the all objects from the receiving set

- (BOOL) isArray

readnonatomicassign

A boolean value that indicates whether a receiving instance is an array of any supported type

- (BOOL) isCollection

readnonatomicassign

A boolean value that indicates whether a receiving instance is a collection of any supported type

- (BOOL) isDictionary

readnonatomicassign

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

A boolean value that indicates whether a receiving instance is a standard dictionary (instances of the classes NSDictionary and NSMutableDictionary)

- (BOOL) isFoundationOrderedSet

readnonatomicassign

A boolean value that indicates whether a receiving instance is a standard orderde set (instances of the classes NSOrderedSet and NSMutableOrderedSet)

- (BOOL) isFoundationSet

readnonatomicassign

A boolean value that indicates whether a receiving instance is a standard set (instances of the classes NSSet and NSMutableSet)

- (BOOL) isLibraryArray

readnonatomicassign

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)

- (BOOL) isLibrarySet

readnonatomicassign

A boolean value that indicates whether a receiving instance is a library set (class SCSet instance)

- (BOOL) isList

readnonatomicassign

A boolean value that indicates whether a receiving instance is a list (instances of the classes SCUnidirectionalList and SCBidirectionalList)

- (BOOL) isOrderedSet

readnonatomicassign

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

- (BOOL) isQueue

readnonatomicassign

A boolean value that indicates whether a receiving instance is a queue (class SCQueue instance)

- (BOOL) isSet

readnonatomicassign

A boolean value that indicates whether a receiving instance is a set of any supported type

- (BOOL) isSortable

readnonatomicassign

A boolean value that indicates whether a receiving instance is a sortable collection (array or ordered set of any supported type)

- (BOOL) isStack

readnonatomicassign

A boolean value that indicates whether a receiving instance is a stack (class SCStack instance)

- (NSString *) name

readnonatomicretain

Name of the set

- (SCOrderedSet *) orderedSet

readnonatomicassign

An ordered set with the all objects from the receiving set

- (SCQueue *) queue

readnonatomicassign

A queue with the all objects from the receiving set

- (BOOL) readOnly

readnonatomicassign

Determines whether the set is in read only mode

- (SCSet *) set

readnonatomicassign

A set with the all objects from the receiving set

- (SCStack *) stack

readnonatomicassign

A stack with the all objects from the receiving set

- (SCUnidirectionalList *) unidirectionalList

readnonatomicassign

An unidirectional list with the all objects from the receiving set

---

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

• NSSet+SCSet.h
• NSSet+SCSet.m