SCDictionary Class Reference

Keyed and tree objects collection. More...

#import <SCDictionary.h>

Inheritance diagram for SCDictionary:

List of all members.

Public Member Functions
Initializing Dictionary
(id)	- init
(id)	- initWithDictionaryName:
(id)	- initWithDelegate:
(id)	- initWithDelegate:collection:
(id)	- initWithCollection:
(id)	- initWithDelegate:object:
(id)	- initWithObject:
(id)	- initWithDelegate:objects:
(id)	- initWithObjects:
(id)	- initWithDictionary:
Querying and Setting Dictionary Properties
(NSString *)	- dictionaryName
(void)	- setDictionaryName:
Accessing Keys and Values
(SCArray *)	- allKeys
(SCArray *)	- allValues
(SCArray *)	- allKeysForObject:
(SCArray *)	- allKeysForByte:
(SCArray *)	- allKeysForUByte:
(SCArray *)	- allKeysForShort:
(SCArray *)	- allKeysForUShort:
(SCArray *)	- allKeysForInteger:
(SCArray *)	- allKeysForUInteger:
(SCArray *)	- allKeysForLong:
(SCArray *)	- allKeysForULong:
(SCArray *)	- allKeysForChar:
(SCArray *)	- allKeysForUnichar:
(SCArray *)	- allKeysForCharString:
(SCArray *)	- allKeysForBool:
(SCArray *)	- allKeysForFloat:
(SCArray *)	- allKeysForDouble:
(id)	- objectForKey:
(NSString *)	- stringForKey:
(NSNumber *)	- numberForKey:
(SCByte)	- byteForKey:
(SCUByte)	- uByteForKey:
(SCShort)	- shortForKey:
(SCUShort)	- uShortForKey:
(SCInteger)	- integerForKey:
(SCUInteger)	- uIntegerForKey:
(SCLong)	- longForKey:
(SCULong)	- uLongForKey:
(char)	- charForKey:
(unichar)	- unicharForKey:
(const char *)	- charStringForKey:
(BOOL)	- boolForKey:
(SCFloat)	- floatForKey:
(SCDouble)	- doubleForKey:
(id)	- valueForKey:
(NSString *)	- stringValueForKey:
(NSNumber *)	- numberValueForKey:
(SCByte)	- byteValueForKey:
(SCUByte)	- uByteValueForKey:
(SCShort)	- shortValueForKey:
(SCUShort)	- uShortValueForKey:
(SCInteger)	- integerValueForKey:
(SCUInteger)	- uIntegerValueForKey:
(SCLong)	- longValueForKey:
(SCULong)	- uLongValueForKey:
(char)	- charValueForKey:
(unichar)	- unicharValueForKey:
(const char *)	- charStringValueForKey:
(BOOL)	- boolValueForKey:
(SCFloat)	- floatValueForKey:
(SCDouble)	- doubleValueForKey:
Find Objects in Dictionary
(BOOL)	- containsObjectForKey:
(BOOL)	- containsStringForKey:
(BOOL)	- containsNumberForKey:
(BOOL)	- containsAnyObjectForKeys:
(BOOL)	- containsAllObjectsForKeys:
Enumerating Dictionaries
(NSEnumerator *)	- keyEnumerator
Adding Objects
(void)	- setObject:forKey:
(void)	- setByte:forKey:
(void)	- setUByte:forKey:
(void)	- setShort:forKey:
(void)	- setUShort:forKey:
(void)	- setInteger:forKey:
(void)	- setUInteger:forKey:
(void)	- setLong:forKey:
(void)	- setULong:forKey:
(void)	- setChar:forKey:
(void)	- setUnichar:forKey:
(void)	- setCharString:forKey:
(void)	- setBool:forKey:
(void)	- setFloat:forKey:
(void)	- setDouble:forKey:
(void)	- setValue:forKey:
(void)	- setByteValue:forKey:
(void)	- setUByteValue:forKey:
(void)	- setShortValue:forKey:
(void)	- setUShortValue:forKey:
(void)	- setIntegerValue:forKey:
(void)	- setUIntegerValue:forKey:
(void)	- setLongValue:forKey:
(void)	- setULongValue:forKey:
(void)	- setCharValue:forKey:
(void)	- setUnicharValue:forKey:
(void)	- setCharStringValue:forKey:
(void)	- setBoolValue:forKey:
(void)	- setFloatValue:forKey:
(void)	- setDoubleValue:forKey:
Removing Objects
(void)	- removeObjectForKey:
(void)	- removeObjectsForKeys:
Static Public Member Functions
Creating Dictionary
(SCDictionary *)	+ dictionaryWithDataDictionary:
(SCDictionary *)	+ dictionaryWithDataDictionaryFromFile:
(SCDictionary *)	+ dictionaryWithCoder:
(SCDictionary *)	+ dictionaryWithContentsOfSerializedFile:
(SCDictionary *)	+ dictionaryWithStream:
(SCDictionary *)	+ dictionaryWithFileStream:
(SCDictionary *)	+ dictionary
(SCDictionary *)	+ dictionaryWithDictionaryName:
(SCDictionary *)	+ dictionaryWithDelegate:
(SCDictionary *)	+ dictionaryWithDelegate:collection:
(SCDictionary *)	+ dictionaryWithCollection:
(SCDictionary *)	+ dictionaryWithDelegate:object:
(SCDictionary *)	+ dictionaryWithObject:
(SCDictionary *)	+ dictionaryWithDelegate:objects:
(SCDictionary *)	+ dictionaryWithObjects:
(SCDictionary *)	+ dictionaryWithDictionary:

---

Detailed Description

Keyed and tree objects collection.

Class represents the collection, which gets access to objects by key strings and can stores items in tree mode.
Class was introduced in version 1.1.3.

Class declares the following properties:

• NSString* dictionaryName - dictionary name

---

Member Function Documentation

- (SCArray *) allKeys

Returns an array containing the dictionary's keys.

Returns:

Array containing the dictionary's keys or an empty array if the dictionary has no entries

- (SCArray *) allKeysForBool:

(BOOL)

boolean

Returns an array containing the keys corresponding to all occurences of a given boolean value in the dictionary.

Parameters:

boolean

- value to look for in the dictionary

Returns:

Array containing the keys corresponding to all occurences of the specified value. If no value is found, returns an empty array.

- (SCArray *) allKeysForByte:

(SCByte)

byte

Returns an array containing the keys corresponding to all occurrences of a given signed 8-bit integer value in the dictionary.

Parameters:

byte	- value to look for in the dictionary

Returns:

Array containing the keys corresponding to all occurrences of the specified value. If no value is found, returns an empty array.

- (SCArray *) allKeysForChar:

(char)

chr

Returns an array containing the keys corresponding to all occurences of a given char value in the dictionary.

Parameters:

chr	- value to look for in the dictionary

Returns:

Array containing the keys corresponding to all occurences of the specified value. If no value is found, returns an empty array.

- (SCArray *) allKeysForCharString:

(const char *)

string

Returns an array containing the keys corresponding to all occurences of a given character string in the dictionary.

Parameters:

string

- string to look for in the dictionary

Returns:

Array containing the keys corresponding to all occurences of the specified string. If no value is found, returns an empty array.

- (SCArray *) allKeysForDouble:

(SCDouble)

dbl

Returns an array containing the keys corresponding to all occurences of a given double precision float value in the dictionary.

Parameters:

dbl	- value to look for in the dictionary

Returns:

Array containing the keys corresponding to all occurences of the specified value. If no value is found, returns an empty array.

- (SCArray *) allKeysForFloat:

(SCFloat)

flt

Returns an array containing the keys corresponding to all occurences of a given single precision float value in the dictionary.

Parameters:

flt	- value to look for in the dictionary

Returns:

Array containing the keys corresponding to all occurences of the specified value. If no value is found, returns an empty array.

- (SCArray *) allKeysForInteger:

(SCInteger)

integer

Returns an array containing the keys corresponding to all occurrences of a given signed 32-bit integer value in the dictionary.

Parameters:

integer

- value to look for in the dictionary

Returns:

Array containing the keys corresponding to all occurrences of the specified value. If no value is found, returns an empty array.

- (SCArray *) allKeysForLong:

(SCLong)

longint

Returns an array containing the keys corresponding to all occurrences of a given signed 64-bit integer value in the dictionary.

Parameters:

longint

- value to look for in the dictionary

Returns:

Array containing the keys corresponding to all occurrences of the specified value. If no value is found, returns an empty array.

- (SCArray *) allKeysForObject:

(id)

object

Returns an array containing the keys corresponding to all occurrences of a given object in the dictionary.

Parameters:

object

- value to look for in the dictionary

Returns:

Array containing the keys corresponding to all occurrences of the specified object. If no object is found, returns an empty array.

- (SCArray *) allKeysForShort:

(SCShort)

shortint

Returns an array containing the keys corresponding to all occurrences of a given signed 16-bit integer value in the dictionary.

Parameters:

shortint

- value to look for in the dictionary

Returns:

Array containing the keys corresponding to all occurrences of the specified value. If no value is found, returns an empty array.

- (SCArray *) allKeysForUByte:

(SCUByte)

byte

Returns an array containing the keys corresponding to all occurrences of a given unsigned 8-bit integer value in the dictionary.

Parameters:

byte	- value to look for in the dictionary

Returns:

Array containing the keys corresponding to all occurrences of the specified value. If no value is found, returns an empty array.

- (SCArray *) allKeysForUInteger:

(SCUInteger)

integer

Returns an array containing the keys corresponding to all occurrences of a given unsigned 32-bit integer value in the dictionary.

Parameters:

integer

- value to look for in the dictionary

Returns:

Array containing the keys corresponding to all occurrences of the specified value. If no value is found, returns an empty array.

- (SCArray *) allKeysForULong:

(SCULong)

longint

Returns an array containing the keys corresponding to all occurrences of a given unsigned 64-bit integer value in the dictionary.

Parameters:

longint

- value to look for in the dictionary

Returns:

Array containing the keys corresponding to all occurrences of the specified value. If no value is found, returns an empty array.

- (SCArray *) allKeysForUnichar:

(unichar)

chr

Returns an array containing the keys corresponding to all occurences of a given unichar value in the dictionary.

Parameters:

chr	- value to look for in the dictionary

Returns:

Array containing the keys corresponding to all occurences of the specified value. If no value is found, returns an empty array.

- (SCArray *) allKeysForUShort:

(SCUShort)

shortint

Returns an array containing the keys corresponding to all occurrences of a given unsigned 16-bit integer value in the dictionary.

Parameters:

shortint

- value to look for in the dictionary

Returns:

Array containing the keys corresponding to all occurrences of the specified value. If no value is found, returns an empty array.

- (SCArray *) allValues

Returns an array containing the dictionary's values.

Returns:

Array containing the dictionary's values or an empty array if the dictionary has no entries

- (BOOL) boolForKey:

(NSString *)

key

Returns the boolean value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (BOOL) boolValueForKey:

(NSString *)

key

Returns the boolean value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (SCByte) byteForKey:

(NSString *)

key

Returns the signed 8-bit integer value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (SCByte) byteValueForKey:

(NSString *)

key

Returns the signed 8-bit integer value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (char) charForKey:

(NSString *)

key

Returns the char value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (const char *) charStringForKey:

(NSString *)

key

Returns the character string associated with a given key.

Parameters:

key	- key for which to return the corresponding string

Returns:

String associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (const char *) charStringValueForKey:

(NSString *)

key

Returns the char string value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (char) charValueForKey:

(NSString *)

key

Returns the char value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (BOOL) containsAllObjectsForKeys:

(SCArray *)

array

Returns a Boolean value that indicates whether an object for all keys from the specified array are present in the receiving dictionary.

Parameters:

array

- array with keys

Returns:

YES if all objects are present in the dictionary, otherwise NO

- (BOOL) containsAnyObjectForKeys:

(SCArray *)

array

Returns a Boolean value that indicates whether an object for at least one key from the specified array is present in the receiving dictionary.

Parameters:

array

- array with keys

Returns:

YES if an object or objects is present in the dictionary, otherwise NO

- (BOOL) containsNumberForKey:

(NSString *)

key

Returns a Boolean value that indicates whether a number for the given key is present in the receiving dictionary.

Parameters:

key	- key for desired number

Returns:

YES if a number for the given key is presend int the dictionary, otherwise NO

- (BOOL) containsObjectForKey:

(NSString *)

key

Returns a Boolean value that indicates whether an object for the given key is present in the receiving dictionary.

Parameters:

key	- key for desired object

Returns:

YES if an object for the given key is present in the dictionary, otherwise NO

- (BOOL) containsStringForKey:

(NSString *)

key

Returns a Boolean value that indicates whether a string for the given key is present in the receiving dictionary.

Parameters:

key	- key for desired string

Returns:

YES if a string for the given key is presend int the dictionary, otherwise NO

+ (SCDictionary *) dictionary

Returns the dictionary created by using the default settings.

Returns:

A created dictionary

Reimplemented from SCCollection.

- (NSString *) dictionaryName

Returns the name of the receiving dictionary.

Returns:

Dictionary name

+ (SCDictionary *) dictionaryWithCoder:

(NSCoder *)

coder

Returns a dictionary created by using the specified coder.

Parameters:

coder

- source coder

Returns:

A created dictionary

+ (SCDictionary *) dictionaryWithCollection:

(id)

collection

Returns the dictionary created by using the specified existing collection.

Parameters:

collection

- existing source collection

Returns:

A created dictionary

Exceptions:

SCCollectionException

- dictionary error detected

+ (SCDictionary *) dictionaryWithContentsOfSerializedFile:

(NSString *)

path

Returns a dictionary created by using the contents of serialized file with the specified path.

Parameters:

path	- source serialized file path

Returns:

A created dictionary

+ (SCDictionary *) dictionaryWithDataDictionary:

(NSDictionary *)

dictionary

Returns a dictionary created by using the specified dictionary.

Parameters:

dictionary

- source dictionary

Returns:

A created dictionary

+ (SCDictionary *) dictionaryWithDataDictionaryFromFile:

(NSString *)

path

Returns a dictionary created by using the dictionary from the specified file.

Parameters:

path	- source dictionary file path

Returns:

A created dictionary

+ (SCDictionary *) dictionaryWithDelegate:

(id<SCCollectionDelegate>)

delegate

Returns the dictionary created by using the specified delegate object.

Parameters:

delegate

- delegate object

Returns:

A created dictionary

+ (SCDictionary *) dictionaryWithDelegate:		(id<SCCollectionDelegate>)	delegate
collection:		(id)	collection

Returns the dictionary created by using the specified delegate object and existing collection.

Parameters:

delegate	- delegate object
collection	- existing source collection

Returns:

A created dictionary

Exceptions:

SCCollectionException

- dictionary error detected

+ (SCDictionary *) dictionaryWithDelegate:		(id<SCCollectionDelegate>)	delegate
object:		(id)	object

Returns the dictionary created by using the specified delegate object and existing object.

Parameters:

delegate	- delegate object
object	- existing source object

Returns:

A created dictionary

Exceptions:

SCCollectionException

- dictionary error detected

+ (SCDictionary *) dictionaryWithDelegate:		(id<SCCollectionDelegate>)	delegate
objects:		(id)	object
,			...

Returns the dictionary created by using the specified delegate objects and nil terminated list of existing objects.

Parameters:

delegate	- delegate object
object	- first object
...	- other objects

Returns:

A created dictionary

Exceptions:

SCCollectionException

- dictionary error detected

+ (SCDictionary *) dictionaryWithDictionary:

(SCDictionary *)

dictionary

Returns the dictionary created by using the existing dictionary.

Parameters:

dictionary

- source dictionary

Returns:

A created dictionary

Exceptions:

SCCollectionError

- dictionary error detected

+ (SCDictionary *) dictionaryWithDictionaryName:

(NSString *)

name

Returns the dictionary created by using the specified dictionary name.

Parameters:

name	- dictionary name

Returns:

A created exception

+ (SCDictionary *) dictionaryWithFileStream:

(NSString *)

path

Returns a dictionary created from the stream file with the specified path.

Parameters:

path	- stream file path

Returns:

A created dictionary

Exceptions:

SCStreamException

- stream operation error detected

+ (SCDictionary *) dictionaryWithObject:

(id)

object

Returns the dictionary created by using the specified existing object.

Parameters:

object

- existing source object

Returns:

A created dictionary

Exceptions:

SCCollectionException

- dictionary error detected

+ (SCDictionary *) dictionaryWithObjects:		(id)	object
,			...

Returns the dictionary created by using the specified nil terminated list of existing objects.

Parameters:

object	- first object
...	- other objects

Returns:

A created dictionary

Exceptions:

SCCollectionException

- dictionary error detected

+ (SCDictionary *) dictionaryWithStream:

(SCStream *)

stream

Returns a dictionary created from the specified stream.

Parameters:

stream

- stream for reading array

Returns:

A created dictionary

Exceptions:

SCStreamException	- stream operation error detected
SCSystemException	- system error detected

- (SCDouble) doubleForKey:

(NSString *)

key

Returns the double precision float value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (SCDouble) doubleValueForKey:

(NSString *)

key

Returns the double precision float value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (SCFloat) floatForKey:

(NSString *)

key

Returns the single precision float value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (SCFloat) floatValueForKey:

(NSString *)

key

Returns the single precision float value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (id) init

Initializes the dictionary using the default settings.

Returns:

A newly initialized dictionary

Reimplemented from SCCollection.

- (id) initWithCollection:

(id)

collection

Initializes the dictionary using the specified existing collection.

Parameters:

collection

- existing source collection

Returns:

A newly initialized dictionary

Exceptions:

SCCollectionException

- dictionary error detected

- (id) initWithDelegate:

(id<SCCollectionDelegate>)

delegate

Initializes the dictionary using the specified delegate object.

Parameters:

delegate

- delegate object

Returns:

A newly initialized dictionary

- (id) initWithDelegate:		(id<SCCollectionDelegate>)	delegate
collection:		(id)	collection

Initializes the dictionary using the specified delegate object and existing collection.

Parameters:

delegate	- delegate object
collection	- existing source collection

Returns:

A newly initialized dictionary

Exceptions:

SCCollectionException

- dictionary error detected

- (id) initWithDelegate:		(id<SCCollectionDelegate>)	delegate
object:		(id)	object

Initializes the dictionary using the specified delegate object and existing object.

Parameters:

delegate	- delegate object
object	- existing source object

Returns:

A newly initialized dictionary

Exceptions:

SCCollectionException

- dictionary error detected

- (id) initWithDelegate:		(id<SCCollectionDelegate>)	delegate
objects:		(id)	object
,			...

Initializes the dictionary using the specified delegate objects and nil terminated list of existing objects.

Parameters:

delegate	- delegate object
object	- first object
...	- other objects

Returns:

A newly initialized dictionary

Exceptions:

SCCollectionException

- dictionary error detected

- (id) initWithDictionary:

(SCDictionary *)

dictionary

Initializes the dictionary using the existing dictionary.

Parameters:

dictionary

- source dictionary

Returns:

A newly initialized dictionary

Exceptions:

SCCollectionError

- dictionary error detected

- (id) initWithDictionaryName:

(NSString *)

name

Initializes the dictionary using the specified dictionary name.

Parameters:

name	- dictionary name

Returns:

A newly initialized dictionary

- (id) initWithObject:

(id)

object

Initializes the dictionary using the specified existing object.

Parameters:

object

- existing source object

Returns:

A newly initialized dictionary

Exceptions:

SCCollectionException

- dictionary error detected

- (id) initWithObjects:		(id)	object
,			...

Initializes the dictionary using the specified nil terminated list of existing objects.

Parameters:

object	- first object
...	- other objects

Returns:

A newly initialized dictionary

Exceptions:

SCCollectionException

- dictionary error detected

- (SCInteger) integerForKey:

(NSString *)

key

Returns the signed 32-bit integer value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (SCInteger) integerValueForKey:

(NSString *)

key

Returns the signed 32-bit integer value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (NSEnumerator *) keyEnumerator

Returns an enumerator object that lets you access each key in the dictionary.

Returns:

Enumerator object

- (SCLong) longForKey:

(NSString *)

key

Returns the signed 64-bit integer value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (SCLong) longValueForKey:

(NSString *)

key

Returns the signed 64-bit integer value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (NSNumber *) numberForKey:

(NSString *)

key

Returns the number associated with a given key.

Parameters:

key	- key for which to return the corresponding number

Returns:

Number associated with a specified key or nil if no number is associated with a key

Exceptions:

SCCollectionException

- dictionary error detected

- (NSNumber *) numberValueForKey:

(NSString *)

key

Returns the number value associated with a given key.

Parameters:

key	- key for which to return the corresponding number value

Returns:

Number value associated with a specified key or nil if no number value is associated with a key

Exceptions:

SCCollectionException

- dictionary error detected

- (id) objectForKey:

(NSString *)

key

Returns the value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key or nil if no value is associated with a key

- (void) removeObjectForKey:

(NSString *)

key

Removes from the receiving dictionary the object with the specified key.

Parameters:

key	- key of the removed object

Exceptions:

SCCollectionException

- dictionary error detected

- (void) removeObjectsForKeys:

(SCArray *)

keys

Removes from the receiving dictionary objects for the keys from the specified array.

Parameters:

keys	- array with removed keys

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setBool:		(BOOL)	boolean
forKey:		(NSString *)	key

Adds a given boolean value with the specified key to the receiving dictionary.

Parameters:

boolean	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setBoolValue:		(BOOL)	value
forKey:		(NSString *)	key

Adds a given boolean value with the specified key to the receiving dictionary.

Parameters:

value	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setByte:		(SCByte)	byte
forKey:		(NSString *)	key

Adds a given signed 8-bit integer value with the specified key to the receiving dictionary.

Parameters:

byte	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setByteValue:		(SCByte)	value
forKey:		(NSString *)	key

Adds a given signed 8-bit integer value with the specified key to the receiving dictionary.

Parameters:

value	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setChar:		(char)	chr
forKey:		(NSString *)	key

Adds a given char value with the specified key to the receiving dictionary.

Parameters:

chr	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setCharString:		(const char *)	string
forKey:		(NSString *)	key

Adds a given char string with the specified key to the receiving dictionary.

Parameters:

string	- string for the specified key
key	- key for the specified string

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setCharStringValue:		(const char *)	value
forKey:		(NSString *)	key

Adds a given char string value with the specified key to the receiving dictionary.

Parameters:

value	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setCharValue:		(char)	value
forKey:		(NSString *)	key

Adds a given char value with the specified key to the receiving dictionary.

Parameters:

value	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setDictionaryName:

(NSString *)

name

Sets the name of the receiving dictionary.

Parameters:

name	- name of the dictionary

- (void) setDouble:		(SCDouble)	dbl
forKey:		(NSString *)	key

Adds a given double precision float value with the specified key to the receiving dictionary.

Parameters:

dbl	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setDoubleValue:		(SCDouble)	value
forKey:		(NSString *)	key

Adds a given double precision float value with the specified key to the receiving dictionary.

Parameters:

value	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setFloat:		(SCFloat)	flt
forKey:		(NSString *)	key

Adds a given single precision float value with the specified key to the receiving dictionary.

Parameters:

flt	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setFloatValue:		(SCFloat)	value
forKey:		(NSString *)	key

Adds a given single precision float value with the specified key to the receiving dictionary.

Parameters:

value	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setInteger:		(SCInteger)	integer
forKey:		(NSString *)	key

Adds a given signed 32-bit integer value with the specified key to the receiving dictionary.

Parameters:

integer	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setIntegerValue:		(SCInteger)	value
forKey:		(NSString *)	key

Adds a given signed 32-bit integer value with the specified key to the receiving dictionary.

Parameters:

value	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setLong:		(SCLong)	longint
forKey:		(NSString *)	key

Adds a given signed 64-bit integer value with the specified key to the receiving dictionary.

Parameters:

longint	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setLongValue:		(SCLong)	value
forKey:		(NSString *)	key

Adds a given signed 64-bit integer value with the specified key to the receiving dictionary.

Parameters:

value	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setObject:		(id)	object
forKey:		(NSString *)	key

Adds a given key-value pair to the receiving dictionary.

Parameters:

object	- value for the specified key
key	- key for the object

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setShort:		(SCShort)	shortint
forKey:		(NSString *)	key

Adds a given signed 16-bit integer value with the specified key to the receiving dictionary.

Parameters:

shortint	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setShortValue:		(SCShort)	value
forKey:		(NSString *)	key

Adds a given signed 16-bit integer value with the specified key to the receiving dictionary.

Parameters:

value	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setUByte:		(SCUByte)	byte
forKey:		(NSString *)	key

Adds a given unsigned 8-bit integer value with the specified key to the receiving dictionary.

Parameters:

byte	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setUByteValue:		(SCUByte)	value
forKey:		(NSString *)	key

Adds a given unsigned 8-bit integer value with the specified key to the receiving dictionary.

Parameters:

value	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setUInteger:		(SCUInteger)	integer
forKey:		(NSString *)	key

Adds a given unsigned 32-bit integer value with the specified key to the receiving dictionary.

Parameters:

integer	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setUIntegerValue:		(SCUInteger)	value
forKey:		(NSString *)	key

Adds a given unsigned 32-bit integer value with the specified key to the receiving dictionary.

Parameters:

value	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setULong:		(SCULong)	longint
forKey:		(NSString *)	key

Adds a given unsigned 64-bit integer value with the specified key to the receiving dictionary.

Parameters:

longint	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setULongValue:		(SCULong)	value
forKey:		(NSString *)	key

Adds a given unsigned 64-bit integer value with the specified key to the receiving dictionary.

Parameters:

value	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setUnichar:		(unichar)	chr
forKey:		(NSString *)	key

Adds a given unichar value with the specified key to the receiving dictionary.

Parameters:

chr	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setUnicharValue:		(unichar)	value
forKey:		(NSString *)	key

Adds a given unichar value with the specified key to the receiving dictionary.

Parameters:

value	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setUShort:		(SCUShort)	shortint
forKey:		(NSString *)	key

Adds a given unsigned 16-bit integer value with the specified key to the receiving dictionary.

Parameters:

shortint	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setUShortValue:		(SCUShort)	value
forKey:		(NSString *)	key

Adds a given unsigned 16-bit integer value with the specified key to the receiving dictionary.

Parameters:

value	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (void) setValue:		(id)	value
forKey:		(NSString *)	key

Adds a given key-value pair to the dictionary.

Parameters:

value	- value for the specified key
key	- key for the specified value

Exceptions:

SCCollectionException

- dictionary error detected

- (SCShort) shortForKey:

(NSString *)

key

Returns the signed 16-bit integer value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (SCShort) shortValueForKey:

(NSString *)

key

Returns the signed 16-bit integer value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (NSString *) stringForKey:

(NSString *)

key

Returns the string associated with a given key.

Parameters:

key	- key for which to return the corresponding string

Returns:

String associated with a specified key or nil if no string is associated with a key

Exceptions:

SCCollectionException

- dictionary error detected

- (NSString *) stringValueForKey:

(NSString *)

key

Returns the string value associated with a given key.

Parameters:

key	- key for which to return the corresponding string value

Returns:

String value associated with a specified key or nil if no string value is associated with a key

Exceptions:

SCCollectionException

- dictionary error detected

- (SCUByte) uByteForKey:

(NSString *)

key

Returns the unsigned 8-bit integer value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (SCUByte) uByteValueForKey:

(NSString *)

key

Returns the unsigned 8-bit integer value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (SCUInteger) uIntegerForKey:

(NSString *)

key

Returns the unsigned 32-bit integer value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (SCUInteger) uIntegerValueForKey:

(NSString *)

key

Returns the unsigned 32-bit integer value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (SCULong) uLongForKey:

(NSString *)

key

Returns the unsigned 64-bit integer value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (SCULong) uLongValueForKey:

(NSString *)

key

Returns the unsigned 64-bit integer value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (unichar) unicharForKey:

(NSString *)

key

Returns the unichar value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (unichar) unicharValueForKey:

(NSString *)

key

Returns the unichar value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (SCUShort) uShortForKey:

(NSString *)

key

Returns the unsigned 16-bit integer value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (SCUShort) uShortValueForKey:

(NSString *)

key

Returns the unsigned 16-bit integer value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with a specified key

Exceptions:

SCCollectionException

- dictionary error detected

- (id) valueForKey:

(NSString *)

key

Returns the value associated with a given key.

Parameters:

key	- key for which to return the corresponding value

Returns:

Value associated with key

---

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

• SCDictionary.h
• SCDictionary.m