Класс SCObject

Общий предок всех остальных классов библиотеки Подробнее...

#import <SCObject.h>

Граф наследования:SCObject:

Поддержка стандартных последовательных файлов
(instancetype)	- initWithCoder:
(instancetype)	- initWithContentsOfSerializedFile:
(void)	- encodeWithCoder:
(BOOL)	- writeContentsToSerializedFile:
(NSString *)	- className

Поддержка словарей
(instancetype)	- initWithDataDictionary:
(instancetype)	- initWithDataDictionaryFromFile:
(void)	- writeToDataDictionary:
(void)	- writeToDataDictionaryFile:atomically:
(void)	- writeToDataDictionaryFile:
(NSDictionary *)	- dataDictionary

Поддержка потоков
(instancetype)	- initWithStream:
(instancetype)	- initWithFileStream:
(void)	- writeToStream:
(void)	- writeToFileStream:
(void)	- appendToFileStream:

Поддержка коллекций
(id)	- copyObject
(SCComparisonResult)	- compareWithObject:

Сравнение экземпляров класса
(BOOL)	- isEqual:

Подробное описание

Общий предок всех остальных классов библиотеки

SDK

macOS 10.6+, iOS 7.0+, GNUStep

Начиная с

версии 1.1.3

Класс SCObject определяет методы, необходимые для взаимодействия с последовательными файлами, коллекциями, потоками и словарями.
Благодаря тому, что все остальные классы (кроме расширяющих стандартную функциональность категорий) являются его потомками, облегчается поддержка множества функций библиотеки - требуется только добавление кода, являющегося специфическим для конкретного класса.

Документация метода

- (void) appendToFileStream:

(NSString *)

path

Метод добавляет данные экземпляра класса в указанный файловый поток.

Аргументы

path	- путь к файлу потока

Исключения

SCStreamException	- ошибка в ходе операции с потоком
SCSystemException	- системная ошибка

- (NSString *) className

Метод возвращает имя класса, к которому относится данный экземпляр.

Возвращает

Имя класса

- (SCComparisonResult) compareWithObject:

(id<SCCollectioning>)

object

Метод возвращает результат сравнения двух экземпляров класса.

Аргументы

object

- второй экземпляр класса для сравнения

Возвращает

Результат сравнения:

• SCComparisonEqual - экземпляры класса равны
• SCComparisonLess - первый экземпляр класса меньше второго
• SCComparisonGreater - первый экземпляр класса больше второго
• SCComparisonNotAllowed - экземпляры класса не могут сравниваться

- (id) copyObject

Метод возвращает копию экземпляра класса.

Возвращает

Копия экземпляра класса

- (NSDictionary *) dataDictionary

Метод возвращает словарь с данными экземпляра класса.

Возвращает

Словарь с данными экземпляра класса

- (void) encodeWithCoder:

(NSCoder *)

coder

Метод записывает данные экземпляра класса в указанный кодировщик данных.

Аргументы

coder

- кодировщик для сохранения данных экземпляра класса

- (instancetype) initWithCoder:

(NSCoder *)

coder

Метод инициализации экземпляра класса с использованием указанного кодировщика данных.

Аргументы

coder

- исходный кодировщик данных

Возвращает

Инициализированный экземпляр класса

- (instancetype) initWithContentsOfSerializedFile:

(NSString *)

path

Метод инициализации экземпляра класса с использованием данных из стандартного последовательного файла с заданным путем.

Аргументы

path	- путь к исходному стандартному последовательному файлу

Возвращает

Инициализированный экземпляр класса

- (instancetype) initWithDataDictionary:

(NSDictionary *)

dictionary

Метод инициализации экземпляра класса на основании данных из указанного словаря.

Аргументы

dictionary

- словарь с исходными данными

Возвращает

Инициализированный экземпляр класса

- (instancetype) initWithDataDictionaryFromFile:

(NSString *)

path

Метод инициализации экземпляра класса на основании данных словаря из указанного файла.

Аргументы

path	- путь к файлу словаря

Возвращает

Инициализированный экземпляр класса

- (instancetype) initWithFileStream:

(NSString *)

path

Метод инициализирует экземпляр класса с использованием данных из указанного файлового потока.

Аргументы

path	- путь к файлу потока

Возвращает

Инициализированный экземпляр класса

Исключения

SCStreamException	- ошибка в ходе операции с потоком
SCSystemException	- системная ошибка

- (instancetype) initWithStream:

(SCStream *)

stream

Метод инициализирует экземпляр класса с использованием данных из указанного потока.

Аргументы

stream

- поток для чтения данных экземпляра класса

Возвращает

Инициализированный экземпляр класса

Исключения

SCStreamException	- ошибка в ходе операции с потоком
SCSystemException	- системная ошибка

- (BOOL) isEqual:

(id)

object

Метод выполняет сравнение двух экземпляров класса.

Аргументы

object

- второй экземпляр для сравнения

Возвращает

YES при равенстве экземпляров класса и NO в противном случае

Переопределяется в SCStrings, SCCollection и SCTextIndex.

- (BOOL) writeContentsToSerializedFile:

(NSString *)

path

Метод записывает данные экземпляра класса в стандартный последовательный файл с указанным путем.

Аргументы

path	- путь к стандартному последовательному файлу для сохранения данных

Возвращает

YES в случае успешного завершения операции и NO в противном случае

- (void) writeToDataDictionary:

(NSMutableDictionary *)

dictionary

Метод сохраняет данные экземпляра класса в указанном словаре.

Аргументы

dictionary

- словарь для сохранения данных

- (void) writeToDataDictionaryFile:

(NSString *)

path

Метод сохраняет данные экземпляра класса в файле словаря с заданным путем с использованием промежуточного файла.

Аргументы

path	- путь к файлу словаря

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

Метод сохраняет данные экземпляра класса в файле словаря с заданным путем.

Аргументы

path	- путь к файлу словаря
atomically	- YES для записи данных через промежуточный файл и NO для записи непосредственно в файл словаря

- (void) writeToFileStream:

(NSString *)

path

Метод записывает данные экземпляра класса в указанный создаваемый файловый поток.

Аргументы

path	- путь к файлу потока

Исключения

SCStreamException	- ошибка в ходе операции с потоком
SCSystemException	- системная ошибка

- (void) writeToStream:

(SCStream *)

stream

Метод записывает данные экземпляра класса в указанный поток.

Аргументы

stream

- поток для записи данных экземпляра класса

Исключения

SCStreamException	- ошибка в ходе операции с потоком
SCSystemException	- системная ошибка

---

Объявления и описания членов классов находятся в файлах:

• SCObject.h
• SCObject.m