NSDictionary+SCDictionary.h

Go to the documentation of this file.

//
//  NSDictionary+SCDictionary.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/NSObject+SCObject.h>
#import <scl/SCCollectionProtocols.h>

#pragma mark -
#pragma mark Class Constants

#define NSDictionaryClass @"NSDictionary"


@interface NSDictionary(SCDictionary) <SCCollection, SCKeyedCollection>

@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 Dictionaries
+ (instancetype)dictionaryWithCoder:(NSCoder *)coder;
+ (instancetype)dictionaryWithContentsOfSerializedFile:(NSString *)path;
+ (instancetype)dictionaryWithDataDictionary:(NSDictionary *)dictionary;
+ (instancetype)dictionaryWithDataDictionaryFromFile:(NSString *)path;
+ (instancetype)dictionaryWithStream:(SCStream *)stream;
+ (instancetype)dictionaryWithFileStream:(NSString *)path;
+ (instancetype)dictionaryWithData:(NSData *)data;
+ (instancetype)dictionaryWithContentsOfURLString:(NSString *)urlString;
+ (instancetype)dictionaryWithCollection:(id<SCCollection>)collection;

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

#pragma mark -
#pragma mark Finding Objects and Keys in a Dictionary
- (BOOL)containsObject:(id<SCCollectioning>)object;
- (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;
- (BOOL)containsKey:(id)key;
- (BOOL)containsKeys:(id)key, ... NS_REQUIRES_NIL_TERMINATION;
- (BOOL)containsKeysFromCollection:(id<SCCollection>)collection;
- (BOOL)containsAnyKey:(id)key, ... NS_REQUIRES_NIL_TERMINATION;
- (BOOL)containsAnyKeyFromCollection:(id<SCCollection>)collection;

#pragma mark -
#pragma mark Accessing Keys and Values
- (id)getObjectForKey:(NSString *)key;

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

#pragma mark -
#pragma mark Deriving New Dictionaries
- (NSDictionary *)dictionaryByAddingObject:(id)object forKey:(id)key;
- (NSDictionary *)dictionaryByAddingObject:(id)object;
- (NSDictionary *)dictionaryByAddingObjects:(NSArray *)objects forKeys:(NSArray *)keys;
- (NSDictionary *)dictionaryByAddingObjects:(id)object, ... NS_REQUIRES_NIL_TERMINATION;
- (NSDictionary *)dictionaryByAddingObjectsAndKeys:(id)object, ... NS_REQUIRES_NIL_TERMINATION;
- (NSDictionary *)dictionaryByAddingCollection:(id<SCCollection>)collection;
- (NSDictionary *)dictionaryByAddingObjectsFromArray:(NSArray *)array;
- (NSDictionary *)dictionaryByAddingArray:(NSArray *)array;
- (NSDictionary *)dictionaryByAddingEntriesFromDictionary:(NSDictionary *)dictionary;
- (NSDictionary *)dictionaryByAddingDictionary:(NSDictionary *)dictionary;

@end