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)	+ setWithCollection:

Initializing Sets
(instancetype)	- initWithCollection:

Protocol SCCollection Implementation
BOOL	empty
BOOL	readOnly
(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

Additional Inherited Members
Instance Methods inherited from <SCCollection>
(NSString *)	- name
(void)	- setName:
(SCIndex)	- count
(BOOL)	- containsObject:
(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

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) 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) 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) 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) 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) 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) 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) 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) 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) 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) 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) 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) 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) 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) 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) 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) 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) 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) 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) 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>.

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

readnonatomicretain

An array with the all objects from the receiving set

- (SCBidirectionalList *) bidirectionalList

readnonatomicretain

A bidirectional list with the all objects from the receiving set

- (SCDictionary *) dictionary

readnonatomicretain

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

readnonatomicretain

A foundation array with the all objects from the receiving set

- (NSDictionary *) foundationDictionary

readnonatomicretain

A foundation dictionary with all objects from the receiving set

- (NSOrderedSet *) foundationOrderedSet

readnonatomicretain

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

SDK

macOS 10.7+, iOS 7.0+

- (NSSet *) foundationSet

readnonatomicretain

A foundation set with the all objects from the receiving set

- (SCOrderedSet *) orderedSet

readnonatomicretain

An ordered set with the all objects from the receiving set

SDK

macOS 10.7+, iOS 7.0+

- (SCQueue *) queue

readnonatomicretain

A queue with the all objects from the receiving set

- (BOOL) readOnly

readnonatomicassign

Determines whether the set is in read only mode

- (SCSet *) set

readnonatomicretain

A set with the all objects from the receiving set

- (SCStack *) stack

readnonatomicretain

A stack with the all objects from the receiving set

- (SCUnidirectionalList *) unidirectionalList

readnonatomicretain

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