SCDictionary.h

Go to the documentation of this file.

//
//  SCDictionary.h
//  scl
//
//  Created by Viacheslav Smolensky on 13.04.12.
//  Copyright (c) 2007 - 2014 by Samond Development Corporation. All rights reserved.
//

#import <scl/SCCollection.h>

#define SCDictionaryClass @"SCDictionary" ///< SCDictionary class name

@interface SCDictionary : SCCollection {
    NSMutableDictionary *fDictionary;   // Internal dictionary
}
#pragma mark -
#pragma mark Class properties
#if (__MAC_OS_X_VERSION_MIN_REQUIRED > 1040) || IOS_TARGET
// Dictionary name property
@property (retain, getter=dictionaryName, setter=setDictionaryName:) NSString *dictionaryName;
#endif

#pragma mark -
#pragma mark Creating Dictionary

+ (SCDictionary *)dictionaryWithDataDictionary:(NSDictionary *)dictionary;

+ (SCDictionary *)dictionaryWithDataDictionaryFromFile:(NSString *)path;

+ (SCDictionary *)dictionaryWithCoder:(NSCoder *)coder;

+ (SCDictionary *)dictionaryWithContentsOfSerializedFile:(NSString *)path;

+ (SCDictionary *)dictionaryWithStream:(SCStream *)stream;

+ (SCDictionary *)dictionaryWithFileStream:(NSString *)path;

+ (SCDictionary *)dictionary;

+ (SCDictionary *)dictionaryWithDictionaryName:(NSString *)name;

+ (SCDictionary *)dictionaryWithDelegate:(id<SCCollectionDelegate>)delegate;

+ (SCDictionary *)dictionaryWithDelegate:(id<SCCollectionDelegate>)delegate
                              collection:(id)collection;

+ (SCDictionary *)dictionaryWithCollection:(id)collection;

+ (SCDictionary *)dictionaryWithDelegate:(id<SCCollectionDelegate>)delegate object:(id)object;

+ (SCDictionary *)dictionaryWithObject:(id)object;

+ (SCDictionary *)dictionaryWithDelegate:(id<SCCollectionDelegate>)delegate objects:(id)object, ...;

+ (SCDictionary *)dictionaryWithObjects:(id)object, ...;

+ (SCDictionary *)dictionaryWithDictionary:(SCDictionary *)dictionary;

#pragma mark -
#pragma mark Initializing Dictionary

- (id)init;

- (id)initWithDictionaryName:(NSString *)name;

- (id)initWithDelegate:(id<SCCollectionDelegate>)delegate;

- (id)initWithDelegate:(id<SCCollectionDelegate>)delegate collection:(id)collection;

- (id)initWithCollection:(id)collection;

- (id)initWithDelegate:(id<SCCollectionDelegate>)delegate object:(id)object;

- (id)initWithObject:(id)object;

- (id)initWithDelegate:(id<SCCollectionDelegate>)delegate objects:(id)object, ...;

- (id)initWithObjects:(id)object, ...;

- (id)initWithDictionary:(SCDictionary *)dictionary;

#pragma mark -
#pragma mark Querying and Setting Dictionary Properties

- (NSString *)dictionaryName;

- (void)setDictionaryName:(NSString *)name;

#pragma mark -
#pragma mark Accessing Keys and Values

- (SCArray *)allKeys;

- (SCArray *)allValues;

- (SCArray *)allKeysForObject:(id)object;

- (SCArray *)allKeysForByte:(SCByte)byte;

- (SCArray *)allKeysForUByte:(SCUByte)byte;

- (SCArray *)allKeysForShort:(SCShort)shortint;

- (SCArray *)allKeysForUShort:(SCUShort)shortint;

- (SCArray *)allKeysForInteger:(SCInteger)integer;

- (SCArray *)allKeysForUInteger:(SCUInteger)integer;

- (SCArray *)allKeysForLong:(SCLong)longint;

- (SCArray *)allKeysForULong:(SCULong)longint;

- (SCArray *)allKeysForChar:(char)chr;

- (SCArray *)allKeysForUnichar:(unichar)chr;

- (SCArray *)allKeysForCharString:(const char *)string;

- (SCArray *)allKeysForBool:(BOOL)boolean;

- (SCArray *)allKeysForFloat:(SCFloat)flt;

- (SCArray *)allKeysForDouble:(SCDouble)dbl;

- (id)objectForKey:(NSString *)key;

- (NSString *)stringForKey:(NSString *)key;

- (NSNumber *)numberForKey:(NSString *)key;

- (SCByte)byteForKey:(NSString *)key;

- (SCUByte)uByteForKey:(NSString *)key;

- (SCShort)shortForKey:(NSString *)key;

- (SCUShort)uShortForKey:(NSString *)key;

- (SCInteger)integerForKey:(NSString *)key;

- (SCUInteger)uIntegerForKey:(NSString *)key;

- (SCLong)longForKey:(NSString *)key;

- (SCULong)uLongForKey:(NSString *)key;

- (char)charForKey:(NSString *)key;

- (unichar)unicharForKey:(NSString *)key;

- (const char *)charStringForKey:(NSString *)key;

- (BOOL)boolForKey:(NSString *)key;

- (SCFloat)floatForKey:(NSString *)key;

- (SCDouble)doubleForKey:(NSString *)key;

- (id)valueForKey:(NSString *)key;

- (NSString *)stringValueForKey:(NSString *)key;

- (NSNumber *)numberValueForKey:(NSString *)key;

- (SCByte)byteValueForKey:(NSString *)key;

- (SCUByte)uByteValueForKey:(NSString *)key;

- (SCShort)shortValueForKey:(NSString *)key;

- (SCUShort)uShortValueForKey:(NSString *)key;

- (SCInteger)integerValueForKey:(NSString *)key;

- (SCUInteger)uIntegerValueForKey:(NSString *)key;

- (SCLong)longValueForKey:(NSString *)key;

- (SCULong)uLongValueForKey:(NSString *)key;

- (char)charValueForKey:(NSString *)key;

- (unichar)unicharValueForKey:(NSString *)key;

- (const char *)charStringValueForKey:(NSString *)key;

- (BOOL)boolValueForKey:(NSString *)key;

- (SCFloat)floatValueForKey:(NSString *)key;

- (SCDouble)doubleValueForKey:(NSString *)key;

#pragma mark -
#pragma mark Find Objects in Dictionary

- (BOOL)containsObjectForKey:(NSString *)key;

- (BOOL)containsStringForKey:(NSString *)key;

- (BOOL)containsNumberForKey:(NSString *)key;

- (BOOL)containsAnyObjectForKeys:(SCArray *)array;

- (BOOL)containsAllObjectsForKeys:(SCArray *)array;

#pragma mark -
#pragma mark Enumerating Dictionaries

- (NSEnumerator *)keyEnumerator;

#pragma mark -
#pragma mark Adding Objects

- (void)setObject:(id)object forKey:(NSString *)key;

- (void)setByte:(SCByte)byte forKey:(NSString *)key;

- (void)setUByte:(SCUByte)byte forKey:(NSString *)key;

- (void)setShort:(SCShort)shortint forKey:(NSString *)key;

- (void)setUShort:(SCUShort)shortint forKey:(NSString *)key;

- (void)setInteger:(SCInteger)integer forKey:(NSString *)key;

- (void)setUInteger:(SCUInteger)integer forKey:(NSString *)key;

- (void)setLong:(SCLong)longint forKey:(NSString *)key;

- (void)setULong:(SCULong)longint forKey:(NSString *)key;

- (void)setChar:(char)chr forKey:(NSString *)key;

- (void)setUnichar:(unichar)chr forKey:(NSString *)key;

- (void)setCharString:(const char *)string forKey:(NSString *)key;

- (void)setBool:(BOOL)boolean forKey:(NSString *)key;

- (void)setFloat:(SCFloat)flt forKey:(NSString *)key;

- (void)setDouble:(SCDouble)dbl forKey:(NSString *)key;

- (void)setValue:(id)value forKey:(NSString *)key;

- (void)setByteValue:(SCByte)value forKey:(NSString *)key;

- (void)setUByteValue:(SCUByte)value forKey:(NSString *)key;

- (void)setShortValue:(SCShort)value forKey:(NSString *)key;

- (void)setUShortValue:(SCUShort)value forKey:(NSString *)key;

- (void)setIntegerValue:(SCInteger)value forKey:(NSString *)key;

- (void)setUIntegerValue:(SCUInteger)value forKey:(NSString *)key;

- (void)setLongValue:(SCLong)value forKey:(NSString *)key;

- (void)setULongValue:(SCULong)value forKey:(NSString *)key;

- (void)setCharValue:(char)value forKey:(NSString *)key;

- (void)setUnicharValue:(unichar)value forKey:(NSString *)key;

- (void)setCharStringValue:(const char *)value forKey:(NSString *)key;

- (void)setBoolValue:(BOOL)value forKey:(NSString *)key;

- (void)setFloatValue:(SCFloat)value forKey:(NSString *)key;

- (void)setDoubleValue:(SCDouble)value forKey:(NSString *)key;

#pragma mark -
#pragma mark Removing Objects

- (void)removeObjectForKey:(NSString *)key;

- (void)removeObjectsForKeys:(SCArray *)keys;

@end