SCObject.h

Go to the documentation of this file.

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

#import <Foundation/Foundation.h>
#import <scl/NSObject+SCObject.h>

@class SCData;
@class SCStream;

#pragma mark -
#pragma mark Class Constants

#define SCObjectClass       @"SCObject"

#pragma mark -

@interface SCObject : NSObject

#pragma mark -
#pragma mark Instance Properties

@property (nonatomic, readonly, copy) NSString *className;

#pragma mark -
#pragma mark Serialized Files Support
- (instancetype)initWithCoder:(NSCoder *)coder;
- (instancetype)initWithContentsOfSerializedFile:(NSString *)path;
- (void)encodeWithCoder:(NSCoder *)coder;
- (BOOL)writeContentsToSerializedFile:(NSString *)path;

#pragma mark -
#pragma mark Data Dictionaries Support
- (instancetype)initWithDataDictionary:(NSDictionary *)dictionary;
- (instancetype)initWithDataDictionaryFromFile:(NSString *)path;
- (void)writeToDataDictionary:(NSMutableDictionary *)dictionary;
- (void)writeToDataDictionaryFile:(NSString *)path atomically:(BOOL)atomically;
- (void)writeToDataDictionaryFile:(NSString *)path;
- (NSDictionary *)dataDictionary;

#pragma mark -
#pragma mark Streams Support
- (instancetype)initWithStream:(SCStream *)stream;
- (instancetype)initWithFileStream:(NSString *)path;
- (void)writeToStream:(SCStream *)stream;
- (void)writeToFileStream:(NSString *)path;
- (void)appendToFileStream:(NSString *)path;

#pragma mark -
#pragma mark Collections Support
- (id)copyObject;
- (SCComparisonResult)compareWithObject:(id<SCCollectioning>)object;

#pragma mark -
#pragma mark Comparing Objects
- (BOOL)isEqual:(id)object;

#pragma mark -
#pragma mark Interaction with Data Objects
- (instancetype)initWithData:(NSData *)data;
- (instancetype)initWithDataWrapper:(SCData *)data;
- (instancetype)initWithContentsOfFile:(NSString *)path;
- (instancetype)initWithContentsOfURL:(NSURL *)url;
- (instancetype)initWithContentsOfURLString:(NSString *)urlString;
- (void)writeToData:(NSMutableData *)data;
- (BOOL)writeToFile:(NSString *)path;
- (BOOL)writeToURL:(NSURL *)url;
- (BOOL)writeToURLString:(NSString *)urlString;
- (NSData *)data;

@end