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 - 2017 by Samond Development Corporation. All rights reserved.
//

#import <Foundation/Foundation.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, assign, readonly, getter=empty) BOOL empty;

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

@property (nonatomic, retain, readonly, getter=array) SCArray *array;

@property (nonatomic, retain, readonly, getter=set) SCSet *set;

#ifndef GNUSTEP
@property (nonatomic, retain, readonly, getter=orderedSet) SCOrderedSet *orderedSet;
#endif

@property (nonatomic, retain, readonly, getter=dictionary) SCDictionary *dictionary;

@property (nonatomic, retain, readonly, getter=stack) SCStack *stack;

@property (nonatomic, retain, readonly, getter=queue) SCQueue *queue;

@property (nonatomic, retain, readonly, getter=unidirectionalList) SCUnidirectionalList *unidirectionalList;

@property (nonatomic, retain, readonly, getter=bidirectionalList) SCBidirectionalList *bidirectionalList;

@property (nonatomic, retain, readonly, getter=foundationArray) NSArray *foundationArray;

@property (nonatomic, retain, readonly, getter=foundationSet) NSSet *foundationSet;

#ifndef GNUSTEP
@property (nonatomic, retain, readonly, getter=foundationOrderedSet) NSOrderedSet *foundationOrderedSet;
#endif

@property (nonatomic, retain, readonly, getter=foundationDictionary) 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)setWithCollection:(id<SCCollection>)collection;

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

#pragma mark -
#pragma mark 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;

#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 Converting Sets
- (SCArray *)array;
- (SCSet *)set;
#ifndef GNUSTEP
- (SCOrderedSet *)orderedSet;
#endif
- (SCDictionary *)dictionary;
- (SCStack *)stack;
- (SCQueue *)queue;
- (SCUnidirectionalList *)unidirectionalList;
- (SCBidirectionalList *)bidirectionalList;
- (NSArray *)foundationArray;
- (NSSet *)foundationSet;
#ifndef GNUSTEP
- (NSOrderedSet *)foundationOrderedSet;
#endif
- (NSDictionary *)foundationDictionary;

@end