SCNull.h

Go to the documentation of this file.

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

#import <Foundation/Foundation.h>
#import <scl/SCDictionaryObjectProtocol.h>
#import <scl/SCCollectionProtocol.h>
#import <scl/SCCodingProtocol.h>
#import <scl/SCStreamProtocol.h>
#import <scl/SCStream.h>

#define NSNullClass @"NSNull" ///< NSNull class name

@interface NSNull(SCNull) <SCDictionaryObjectProtocol, SCCollectionProtocol, SCCodingProtocol,
                           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

+ (NSNull *)nullWithContentsOfSerializedFile:(NSString *)path;

+ (NSNull *)nullWithDataDictionary:(NSDictionary *)dictionary;

+ (NSNull *)nullWithDataDictionaryFromFile:(NSString *)path;

+ (NSNull *)nullWithCoder:(NSCoder *)coder;

+ (NSNull *)nullWithStream:(SCStream *)stream;

+ (NSNull *)nullWithFileStream:(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;

- (NSString *)className;

#pragma mark -
#pragma mark Supporting Streams

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

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

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

@end