NSNull(SCNull) Category Reference

Standard class NSNull functionality extending category. More...

#import <SCNull.h>

Inheritance diagram for NSNull(SCNull):

Serialized Files Support
(NSNull *)	+ nullWithCoder:
(NSNull *)	+ nullWithContentsOfSerializedFile:
(id)	- initWithContentsOfSerializedFile:
(BOOL)	- writeContentsToSerializedFile:

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

Streams Support
(NSNull *)	+ nullWithStream:
(NSNull *)	+ nullWithFileStream:
(id)	- initWithStream:
(id)	- initWithFileStream:
(void)	- writeToStream:
(void)	- writeToFileStream:
(void)	- appendToFileStream:

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

Additional Inherited Members

Instance Methods inherited from <SCCoding>

Instance Methods inherited from <SCDictionaring>

Instance Methods inherited from <SCCollectioning>

Detailed Description

Standard class NSNull functionality extending category.

Since

version 1.1.3

Declares the additional methods for add into the standard class NSNull the additional functionality such as dictionaries, collections and streams support and so on.

Method Documentation

- (void) appendToFileStream:

(NSString *)

path

Appends the receiving class instance to the file stream with the specified path.

Parameters

path	- the path to the destination file stream

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

Reimplemented from <SCStreaming>.

- (SCComparisonResult) compareWithObject:

(id<SCCollectioning>)

object

Returns the result of comparison the receiving class instance with a given another class instance.

Parameters

object

- the second class instance for comparison

Returns

Comparison result:

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

Reimplemented from <SCCollectioning>.

- (id< SCCollectioning >) copyObject

Returns a copy of the receiving class instance.

Returns

A copy of the receiving class instance

Reimplemented from <SCCollectioning>.

- (NSDictionary *) dataDictionary

Returns the dictionary with the receiving class instance.

Returns

A dictionary which contains the receiving class instance

Reimplemented from <SCDictionaring>.

- (id) initWithContentsOfSerializedFile:

(NSString *)

path

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

Parameters

path	- the path to the serialized file

Returns

A newly initialized class instance

Reimplemented from <SCCoding>.

- (id) initWithDataDictionary:

(NSDictionary *)

dictionary

Initializes a class instance 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 using the data from the dictionary file with the specified path.

Parameters

path	- the path to the source dictionary file

Returns

A newly initialized class instance

Reimplemented from <SCDictionaring>.

- (id) initWithFileStream:

(NSString *)

path

Initializes a 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 a 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>.

+ (NSNull *) nullWithCoder:

(NSCoder *)

coder

Returns a class instance created by using the data from the specified coder.

Parameters

coder

- the source coder

Returns

A created class instance

+ (NSNull *) nullWithContentsOfSerializedFile:

(NSString *)

path

Returns a class instance created by using the data from the serialized file with the specified path.

Parameters

path	- the path to the serialized file

Returns

A created class instance

+ (NSNull *) nullWithDataDictionary:

(NSDictionary *)

dictionary

Returns a class instance created by using the data from the specified data dictionary.

Parameters

dictionary

- the source data dictionary

Returns

A created class instance

+ (NSNull *) nullWithDataDictionaryFromFile:

(NSString *)

path

Returns a class instance created by using the data from the dictionary file with the specified path.

Parameters

path	- the path to the source dictionary file

Returns

A created class instance

+ (NSNull *) nullWithFileStream:

(NSString *)

path

Returns a class instance created by using the data from the file stream with the specified path.

Parameters

path	- the path to the source file stream

Returns

A created class instance

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

+ (NSNull *) nullWithStream:

(SCStream *)

stream

Returns a class instance created by using the data from the specified stream.

Parameters

stream

- the source stream

Returns

A created class instance

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

- (BOOL) writeContentsToSerializedFile:

(NSString *)

path

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

Parameters

path	- the path to the serialized file

Returns

YES if the operation is successfully, otherwise NO

Reimplemented from <SCCoding>.

- (void) writeToDataDictionary:

(NSMutableDictionary *)

dictionary

Writes the receiving class instance into the specified data dictionary.

Parameters

dictionary

- the dictionary to store 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.

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 receiving class instance to the file stream with the specified path.

Parameters

path	- the path to the destination file stream

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

Reimplemented from <SCStreaming>.

- (void) writeToStream:

(SCStream *)

stream

Writes the receiving class instance to the specified stream.

Parameters

stream

- the destination stream

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

Reimplemented from <SCStreaming>.

---

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

• SCNull.h
• SCNull.m