SCObject.h

Go to the documentation of this file.

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

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

#define SCObjectClass @"SCObject" ///< SCObject class name

#pragma mark -
#pragma mark Class related constants

#define SC_KEY_CLASS_NAME   @"OBJC_ClassName"   ///< Class instance class name key

#pragma mark -

@interface SCObject : NSObject <SCDictionaryObjectProtocol, SCCodingProtocol, SCStreamProtocol,
                                SCCollectionProtocol>
{

}
#pragma mark -
#pragma mark Class 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 Supporting Data Dictionaries

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

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

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

- (id)initWithCoder:(NSCoder *)coder;

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

- (void)encodeWithCoder:(NSCoder *)coder;

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

#pragma mark -
#pragma mark Supporting Streams

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

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

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

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

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

#pragma mark -
#pragma mark Supporting Collections

- (id<SCCollectionProtocol>)copyObject;

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

- (NSString *)className;

#pragma mark -
#pragma mark Comparing Objects

- (BOOL)isEqual:(id)object;

@end