SCObject Class Reference

Parent class of all library classes. More...

#import <SCObject.h>

Inheritance diagram for SCObject:

Instance Properties
NSString *	className

Serialized Files Support
(instancetype)	- initWithCoder:
(instancetype)	- initWithContentsOfSerializedFile:
(void)	- encodeWithCoder:
(BOOL)	- writeContentsToSerializedFile:

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

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

Collections Support
(id)	- copyObject
(SCComparisonResult)	- compareWithObject:

Comparing Objects
(BOOL)	- isEqual:

Interaction with Data Objects
(instancetype)	- initWithData:
(instancetype)	- initWithDataWrapper:
(instancetype)	- initWithContentsOfFile:
(instancetype)	- initWithContentsOfURL:
(instancetype)	- initWithContentsOfURLString:
(void)	- writeToData:
(BOOL)	- writeToFile:
(BOOL)	- writeToURL:
(BOOL)	- writeToURLString:
(NSData *)	- data

Detailed Description

Parent class of all library classes.

SDK

macOS 10.6+, iOS 7.0+, GNUstep

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

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

- (id) copyObject

Returns the copy of the receiving instance.

Returns

Receiving instance copy

- (NSData *) data

Returns the data object with the receiving class instance.

Returns

A data object

- (NSDictionary *) dataDictionary

Returns the data dictionary with the receiving class instance data.

Returns

A data dictionary with the class instance data

- (void) encodeWithCoder:

(NSCoder *)

coder

Writes the receiving class instance data into the specified coder.

Parameters

coder

- the coder to write class instance data

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

- (instancetype) initWithContentsOfFile:

(NSString *)

path

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

Parameters

path	- the path to the source file

Returns

A newly initialized class instance

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

- (instancetype) initWithContentsOfURL:

(NSURL *)

url

Initializes a class instance using the data from the specified URL.

Parameters

url	- the source URL

Returns

A newly initialized class instance

- (instancetype) initWithContentsOfURLString:

(NSString *)

urlString

Initializes a class instance using the data from the specified URL string.

Parameters

urlString

- the source URL string

Returns

A newly initialized class instance

- (instancetype) initWithData:

(NSData *)

data

Initializes a class instance using the specified data object.

Parameters

data	- the source data object

Returns

A newly initialized class instance

Reimplemented in SCData.

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

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

- (instancetype) initWithDataWrapper:

(SCData *)

data

Initializes a class instance using the specified data object wrapper.

Parameters

data	- the data object wrapper

Returns

A newly initialized class instance

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

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

- (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 SCCollection, SCRuntimeProperty, SCStrings, SCRuntimeMethod, SCRuntimeUnregisteredClass, SCRuntimeVariable, SCRuntimeProtocol, 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

- (void) writeToData:

(NSMutableData *)

data

Writes the receiving class instance into the specified data object.

Parameters

data	- the destination data object

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

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

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

- (BOOL) writeToFile:

(NSString *)

path

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

Parameters

path	- the path of the destination file

Returns

YES if the operation succeeds, otherwise NO

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

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

- (BOOL) writeToURL:

(NSURL *)

url

Writes the receiving class instance into the specified URL.

Parameters

url	- the destination URL

Returns

YES if the operation succeeds, otherwise NO

- (BOOL) writeToURLString:

(NSString *)

urlString

Writes the receiving class instance into the specified URL string.

Parameters

urlString

- the destination URL string

Returns

YES if the operation succeeds, otherwise NO

Property Documentation

- (NSString *) className

readnonatomiccopy

A name of the receiving instance class

---

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

• SCObject.h
• SCObject.m