NSSet+SCSet.h

Go to the documentation of this file.

//
//  NSSet+SCSet.h
//  scl
//
//  Created by Viacheslav Smolensky on 13.05.12.
//  Copyright (c) 2007 - 2018 by Samond Development Corporation. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <scl/NSArray+SCArray.h>
#import <scl/NSDictionary+SCDictionary.h>
#import <scl/NSObject+SCObject.h>
#import <scl/SCCollectionProtocols.h>

#pragma mark -
#pragma mark Class Constants

#define NSSetClass @"NSSet"


@interface NSSet(SCSet) <SCCollection>
@property (nonatomic, readonly, retain) NSString *name;

@property (nonatomic, readonly, assign) BOOL empty;

@property (nonatomic, readonly, assign) BOOL readOnly;

@property (nonatomic, readonly, retain) id<SCCollectionDelegate> delegate;

@property (nonatomic, readonly, assign) SCCollectionType collectionType;

@property (nonatomic, readonly, assign) BOOL isCollection;

@property (nonatomic, readonly, assign) BOOL isLibraryCollection;

@property (nonatomic, readonly, assign) BOOL isFoundationCollection;

@property (nonatomic, readonly, assign) BOOL isArray;

@property (nonatomic, readonly, assign) BOOL isLibraryArray;

@property (nonatomic, readonly, assign) BOOL isFoundationArray;

@property (nonatomic, readonly, assign) BOOL isSet;

@property (nonatomic, readonly, assign) BOOL isLibrarySet;

@property (nonatomic, readonly, assign) BOOL isFoundationSet;

@property (nonatomic, readonly, assign) BOOL isOrderedSet;

@property (nonatomic, readonly, assign) BOOL isLibraryOrderedSet;

@property (nonatomic, readonly, assign) BOOL isFoundationOrderedSet;

@property (nonatomic, readonly, assign) BOOL isDictionary;

@property (nonatomic, readonly, assign) BOOL isLibraryDictionary;

@property (nonatomic, readonly, assign) BOOL isFoundationDictionary;

@property (nonatomic, readonly, assign) BOOL isStack;

@property (nonatomic, readonly, assign) BOOL isQueue;

@property (nonatomic, readonly, assign) BOOL isList;

@property (nonatomic, readonly, assign) BOOL isSortable;

@property (nonatomic, readonly, assign) SCArray *array;

@property (nonatomic, readonly, assign) SCSet *set;

@property (nonatomic, readonly, assign) SCOrderedSet *orderedSet;

@property (nonatomic, readonly, assign) SCDictionary *dictionary;

@property (nonatomic, readonly, assign) SCStack *stack;

@property (nonatomic, readonly, assign) SCQueue *queue;

@property (nonatomic, readonly, assign) SCUnidirectionalList *unidirectionalList;

@property (nonatomic, readonly, assign) SCBidirectionalList *bidirectionalList;

@property (nonatomic, readonly, assign) NSArray *foundationArray;

@property (nonatomic, readonly, assign) NSSet *foundationSet;

@property (nonatomic, readonly, assign) NSOrderedSet *foundationOrderedSet;

@property (nonatomic, readonly, assign) NSDictionary *foundationDictionary;

#pragma mark -
#pragma mark Creating Sets
+ (instancetype)setWithCoder:(NSCoder *)coder;
+ (instancetype)setWithContentsOfSerializedFile:(NSString *)path;
+ (instancetype)setWithDataDictionary:(NSDictionary *)dictionary;
+ (instancetype)setWithDataDictionaryFromFile:(NSString *)path;
+ (instancetype)setWithStream:(SCStream *)stream;
+ (instancetype)setWithFileStream:(NSString *)path;
+ (instancetype)setWithData:(NSData *)data;
+ (instancetype)setWithContentsOfFile:(NSString *)path;
+ (instancetype)setWithContentsOfURL:(NSURL *)url;
+ (instancetype)setWithContentsOfURLString:(NSString *)urlString;
+ (instancetype)setWithCollection:(id<SCCollection>)collection;

#pragma mark -
#pragma mark Initializing Sets
- (instancetype)initWithCollection:(id<SCCollection>)collection;

#pragma mark -
#pragma mark Finding Objects in a Set
- (BOOL)containsObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (BOOL)containsCollection:(id<SCCollection>)collection;
- (BOOL)containsAnyObject:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (BOOL)containsAnyObjectFromCollection:(id<SCCollection>)collection;

#pragma mark -
#pragma mark Comparing Sets
- (BOOL)isEqualToCollection:(id<SCCollection>)collection;

#pragma mark -
#pragma mark Deriving New Sets
- (NSSet *)setByAddingObjects:(id)object, ... NS_REQUIRES_NIL_TERMINATION;
- (NSSet *)setByAddingArray:(NSArray *)array;
- (NSSet *)setByAddingSet:(NSSet *)set;
- (NSSet *)setByAddingCollection:(id<SCCollection>)collection;

@end