SCObject Class Reference

Parent class of all library classes. More...

#import <SCObject.h>

Inheritance diagram for SCObject:

Serialized Files Support
(id)	- initWithCoder:
(id)	- initWithContentsOfSerializedFile:
(void)	- encodeWithCoder:
(BOOL)	- writeContentsToSerializedFile:
(NSString *)	- className

Data Dictionaries Support
(id)	- initWithDataDictionary:
(id)	- initWithDataDictionaryFromFile:
(void)	- writeToDataDictionary:
(void)	- writeToDataDictionaryFile:atomically:
(void)	- writeToDataDictionaryFile:
(NSDictionary *)	- dataDictionary

Streams Support
(id)	- initWithStream:
(id)	- initWithFileStream:
(void)	- writeToStream:
(void)	- writeToFileStream:
(void)	- appendToFileStream:

Collections Support
(id< SCCollectioning >)	- copyObject
(SCComparisonResult)	- compareWithObject:

Comparing Objects
(BOOL)	- isEqual:

Additional Inherited Members

Instance Methods inherited from <SCCoding>

Instance Methods inherited from <SCDictionaring>

Instance Methods inherited from <SCCollectioning>

Detailed Description

Parent class of all library classes.

Since

version 1.1.3

Defines the methods, which are using for communicate with the serialized files, collections, streams and dictionaries.

Method Documentation

- (void) appendToFileStream:

(NSString *)

path

Appends the class instance data into the file stream with the specified path.

Parameters

path	- the path to the output file stream

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

Reimplemented from <SCStreaming>.

- (NSString *) className

Returns the name of the receiving instance class.

Returns

A class name

Reimplemented from <SCCoding>.

- (SCComparisonResult) compareWithObject:

(id<SCCollectioning>)

object

Returns the result of comparison the receiving instance with the specified instance.

Parameters

object

- second instance for comparison

Returns

Comparison result:

• SCComparisonEqual - instances are equal
• SCComparisonLess - the receiving instance is less than the specified instance
• SCComparisonGreater - the receiving instance is greater than the specified instance
• SCComparisonNotAllowed - instances cannot be compared

Reimplemented from <SCCollectioning>.

- (id< SCCollectioning >) copyObject

Returns the copy of the receiving instance.

Returns

Receiving instance copy

Reimplemented from <SCCollectioning>.

- (NSDictionary *) dataDictionary

Returns the data dictionary with the receiving class instance data.

Returns

A data dictionary with the class instance data

Reimplemented from <SCDictionaring>.

- (void) encodeWithCoder:

(NSCoder *)

coder

Writes the receiving class instance data into the specified coder.

Parameters

coder

- the coder to write class instance data

- (id) initWithCoder:

(NSCoder *)

coder

Initializes a class instance by using the data from the specified source coder.

Parameters

coder

- the source coder

Returns

A newly initialized class instance

- (id) initWithContentsOfSerializedFile:

(NSString *)

path

Initializes a class instance by using the content of the serialized file with the specified path.

Parameters

path	- the path to the source serialized file

Returns

A newly initialized class instance

Reimplemented from <SCCoding>.

- (id) initWithDataDictionary:

(NSDictionary *)

dictionary

Initializes a class instance by using the data from the specified data dictionary.

Parameters

dictionary

- the source data dictionary

Returns

A newly initialized class instance

Reimplemented from <SCDictionaring>.

- (id) initWithDataDictionaryFromFile:

(NSString *)

path

Initializes a class instance by using the data from the specified data dictionary file.

Parameters

path	- the path to the data dictionary file

Returns

A newly initialized class instance

Reimplemented from <SCDictionaring>.

- (id) initWithFileStream:

(NSString *)

path

Initializes the class instance using the data from the file stream with the specified path.

Parameters

path	- the path to the source file stream

Returns

A newly initialized class instance

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

Reimplemented from <SCStreaming>.

- (id) initWithStream:

(SCStream *)

stream

Initializes the class instance using the data from the specified stream.

Parameters

stream

- the source stream

Returns

A newly initialized class instance

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

Reimplemented from <SCStreaming>.

- (BOOL) isEqual:

(id)

object

Returns a boolean value that indicates whether the receiving class instance is equal to an another given class instance.

Parameters

object

- the class instance with which to compare the receiving class instance

Returns

YES if the other class instance is equal to the receiving class instance, otherwise NO

Reimplemented in SCStrings, SCCollection, and SCTextIndex.

- (BOOL) writeContentsToSerializedFile:

(NSString *)

path

Writes the receiving class instance into the serialized file with the specified path.

Parameters

path	- the path to the serialized file

Returns

YES if the operation is successfully complited, otherwise NO

Reimplemented from <SCCoding>.

- (void) writeToDataDictionary:

(NSMutableDictionary *)

dictionary

Writes the receiving class instance into the specified data dictionary.

Parameters

dictionary

- the data dictionary for storing the receiving class instance

Reimplemented from <SCDictionaring>.

- (void) writeToDataDictionaryFile:

(NSString *)

path

Writes the receiving class instance into the data dictionary file with the specified path and using the intermediate file.

Parameters

path	- the path to the data dictionary file

Reimplemented from <SCDictionaring>.

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

Writes the receiving class instance into the data dictionary file with the specified path.

Parameters

path	- the path to the data dictionary file
atomically	- YES for using the intermediate file and NO for direct writing operation

Reimplemented from <SCDictionaring>.

- (void) writeToFileStream:

(NSString *)

path

Writes the class instance data into the file stream with the specified path.

Parameters

path	- the path to the output file stream

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

Reimplemented from <SCStreaming>.

- (void) writeToStream:

(SCStream *)

stream

Writes the class instance data into the specified stream.

Parameters

stream

- the output stream

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

Reimplemented from <SCStreaming>.

---

The documentation for this class was generated from the following files:

• SCObject.h
• SCObject.m