SCDictionary.h

Go to the documentation of this file.

//
//  SCDictionary.h
//  scl
//
//  Created by Viacheslav Smolensky on 13.04.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/SCCollection.h>

#pragma mark -
#pragma mark Class Constants

#define SCDictionaryClass           @"SCDictionary"


@interface SCDictionary : SCCollection <SCKeyedCollection, SCMutableKeyedCollection> {
    NSMutableDictionary *_dictionary;   // Internal data storage
}

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

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

@property (nonatomic, readonly, assign) NSEnumerator *keyEnumerator;

#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)dictionaryWithContentsOfFile:(NSString *)path;
+ (instancetype)dictionaryWithContentsOfURL:(NSURL *)url;
+ (instancetype)dictionaryWithContentsOfURLString:(NSString *)urlString;

+ (instancetype)dictionaryWithName:(NSString *)name;
+ (instancetype)dictionaryWithObject:(id<SCCollectioning>)object forKey:(NSString *)key;
+ (instancetype)dictionaryWithObject:(id<SCCollectioning>)object;
+ (instancetype)dictionaryWithObjects:(id<SCCollection>)objects forKeys:(id<SCCollection>)keys;
+ (instancetype)dictionaryWithObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
+ (instancetype)dictionaryWithObjectsAndKeys:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
+ (instancetype)dictionaryWithCollection:(id<SCCollection>)collection;
+ (instancetype)dictionaryWithDictionary:(SCDictionary *)dictionary;
+ (instancetype)dictionary;

#pragma mark -
#pragma mark Initializing Dictionaries
- (instancetype)initWithName:(NSString *)name;
- (instancetype)initWithObject:(id<SCCollectioning>)object forKey:(NSString *)key;
- (instancetype)initWithObject:(id<SCCollectioning>)object;
- (instancetype)initWithObjects:(id<SCCollection>)objects forKeys:(id<SCCollection>)keys;
- (instancetype)initWithObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (instancetype)initWithObjectsAndKeys:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (instancetype)initWithCollection:(id<SCCollection>)collection;
- (instancetype)initWithDictionary:(SCDictionary *)dictionary;
- (instancetype)init;

#pragma mark -
#pragma mark Copying Dictionaries
- (void)setDictionary:(SCDictionary *)dictionary;

#pragma mark -
#pragma mark Comparing Dictionaries
- (BOOL)isEqualToDictionary:(SCDictionary *)dictionary;

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

#pragma mark -
#pragma mark Adding and Changing Objects
- (void)setObject:(id<SCCollectioning>)object forKey:(NSString *)key;
- (void)setObjects:(id<SCCollection>)objects forKeys:(id<SCCollection>)keys;
- (void)setObjectsAndKeys:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (void)setValue:(id<SCCollectioning>)value forKey:(NSString *)key;
- (void)setValues:(id<SCCollection>)values forKeys:(id<SCCollection>)keys;
- (void)setValuesAndKeys:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (void)addObjectsFromArray:(SCArray *)array;
- (void)addArray:(SCArray *)array;
- (void)addEntriesFromDictionary:(SCDictionary *)dictionary;
- (void)addDictionary:(SCDictionary *)dictionary;
- (void)addObjects:(id<SCCollection>)objects forKeys:(id<SCCollection>)keys;
- (void)addObjectsAndKeys:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (void)setObject:(id<SCCollectioning>)object forKeyedSubscript:(NSString *)key;

#pragma mark -
#pragma mark Removing Objects
- (void)removeObjectForKey:(NSString *)key;
- (void)removeObjectsForKeys:(SCArray *)keys;

#pragma mark -
#pragma mark Querying a Dictionary
- (SCArray *)allKeysForObject:(id<SCCollectioning>)object;
- (id)objectForKey:(NSString *)key;
- (id)objectForKeyedSubscript:(NSString *)key;
- (id)valueForKey:(NSString *)key;

#pragma mark -
#pragma mark Finding Objects and Keys in a Dictionary
- (BOOL)containsObjectForKey:(NSString *)key;
- (BOOL)containsStringForKey:(NSString *)key;
- (BOOL)containsNumberForKey:(NSString *)key;
- (BOOL)containsAnyObjectForKeys:(id<SCCollection>)keys;
- (BOOL)containsAllObjectsForKeys:(id<SCCollection>)keys;
- (BOOL)containsKey:(NSString *)key;
- (BOOL)containsKeys:(NSString *)key, ... NS_REQUIRES_NIL_TERMINATION;
- (BOOL)containsKeysFromCollection:(id<SCCollection>)collection;
- (BOOL)containsAnyKey:(NSString *)key, ... NS_REQUIRES_NIL_TERMINATION;
- (BOOL)containsAnyKeyFromCollection:(id<SCCollection>)collection;

@end