SCNSDictionary.h

Go to the documentation of this file.

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

#import <Foundation/Foundation.h>
#import <scl/SCCollectionProtocol.h>
#import <scl/SCDictionaryObjectProtocol.h>

#define NSDictionaryClass @"NSDictionary" ///< NSDictionary class name

@interface NSDictionary(SCNSDictionary) <SCCollectionProtocol, SCDictionaryObjectProtocol,
                                         SCStreamProtocol>
#pragma mark -
#pragma mark Category properties
#if (__MAC_OS_X_VERSION_MIN_REQUIRED > 1040) || IOS_TARGET
// Instance class name property
@property (retain, readonly, getter=className) NSString *className;
#endif

#pragma mark -
#pragma mark Creating and Initializing Class Instance

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

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

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

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

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

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

- (id)initWithContentsOfSerializedFile:(NSString *)path;

- (id)initWithDataDictionary:(NSDictionary *)dictionary;

- (id)initWithDataDictionaryFromFile:(NSString *)path;

- (id)initWithStream:(SCStream *)stream;

- (id)initWithFileStream:(NSString *)path;

#pragma mark -
#pragma mark Supporting Data Dictionaries

- (void)writeToDataDictionary:(NSMutableDictionary *)dictionary;

- (void)writeToDataDictionaryFile:(NSString *)path atomically:(BOOL)atomically;

- (void)writeToDataDictionaryFile:(NSString *)path;

- (NSDictionary *)dataDictionary;

#pragma mark -
#pragma mark Supporting Coders and Serialized Files

- (BOOL)writeContentsToSerializedFile:(NSString *)path;

#pragma mark -
#pragma mark Supporting Collections

- (id<SCCollectionProtocol>)copyObject;

- (SCComparisonResult)compareWithObject:(id<SCCollectionProtocol>)object;

#pragma mark -
#pragma mark Supporting Streams

- (void)writeToStream:(SCStream *)stream;

- (void)writeToFileStream:(NSString *)path;

- (void)appendToFileStream:(NSString *)path;

#pragma mark -
#pragma mark Other Methods

- (NSString *)className;

#pragma mark -
#pragma mark Detecting Collection Type

- (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;

@end