<SCDictionaring> Protocol Reference

Protocol of methods for data exchanging between class instances and classes NSDictionary and NSMutableDictionary. More...

#import <SCDictionaring.h>

Inheritance diagram for <SCDictionaring>:

Instance Properties
NSString *	className

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

Detailed Description

Protocol of methods for data exchanging between class instances and classes NSDictionary and NSMutableDictionary.

SDK

macOS 10.6+, iOS 7.0+, GNUstep

Since

version 1.1.3

Declares the methods, which are required for reading and writing data from and to instances of the classes NSDictionary and NSMutableDictionary. Also protocol describes the methods for initialing the class instances by using the data from the dictionaries and property lists.

Method Documentation

- (NSDictionary *) dataDictionary

Returns the data dictionary with the receiving class instance data.

Returns

A data dictionary with the class instance data

Reimplemented in NSObject(SCObject).

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

Reimplemented in NSObject(SCObject).

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

Reimplemented in NSObject(SCObject).

- (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 in NSObject(SCObject).

- (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 in NSObject(SCObject).

- (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 in NSObject(SCObject).

Property Documentation

- (NSString*) className

readnonatomiccopy

A name of the receiving instance class

---

The documentation for this protocol was generated from the following file:

• SCDictionaring.h