Dictionary class. More...

#import <SCDictionary.h>

Inheritance diagram for SCDictionary:

Creating Dictionaries
(SCDictionary *)	+ dictionaryWithCoder:

(SCDictionary *)	+ dictionaryWithContentsOfSerializedFile:

(SCDictionary *)	+ dictionaryWithDataDictionary:

(SCDictionary *)	+ dictionaryWithDataDictionaryFromFile:

(SCDictionary *)	+ dictionaryWithStream:

(SCDictionary *)	+ dictionaryWithFileStream:

(SCDictionary *)	+ dictionaryWithName:

(SCDictionary *)	+ dictionaryWithObject:forKey:

(SCDictionary *)	+ dictionaryWithObject:

(SCDictionary *)	+ dictionaryWithObjects:forKeys:

(SCDictionary *)	+ dictionaryWithObjects:

(SCDictionary *)	+ dictionaryWithObjectsAndKeys:

(SCDictionary *)	+ dictionaryWithCollection:

(SCDictionary *)	+ dictionaryWithDictionary:

(SCDictionary *)	+ dictionary

Initializing Dictionaries
(id)	- initWithName:

(id)	- initWithObject:forKey:

(id)	- initWithObject:

(id)	- initWithObjects:forKeys:

(id)	- initWithObjects:

(id)	- initWithObjectsAndKeys:

(id)	- initWithCollection:

(id)	- initWithDictionary:

(id)	- init

Copying Dictionaries
(void)	- setDictionary:

Comparing Dictionaries
(BOOL)	- isEqualToDictionary:

(BOOL)	- isEqualToContentsOfDictionary:

Adding and Changing 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)	- setObjects:forKeys:

(void)	- setObjectsAndKeys:

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

(void)	- setValues:forKeys:

(void)	- setValuesAndKeys:

Removing Objects
(void)	- removeObjectForKey:

(void)	- removeObjectsForKeys:

Querying a Dictionary
SCArray *	allKeys

SCArray *	allValues

(SCArray *)	- allKeysForObject:

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

Finding Objects in a Dictionary
(BOOL)	- containsObjectForKey:

(BOOL)	- containsStringForKey:

(BOOL)	- containsNumberForKey:

(BOOL)	- containsAnyObjectForKeys:

(BOOL)	- containsAllObjectsForKeys:

Objects Enumerators
NSEnumerator *	keyEnumerator

Additional Inherited Members
Instance Methods inherited from SCCollection
(void)	- setCollection:

(void)	- setObject:

(void)	- setObjects:

(BOOL)	- isEqualToCollection:

(BOOL)	- isEqual:

(void)	- enumerateWithDelegate:

(void)	- enumerate

(void)	- reverseEnumerateWithDelegate:

(void)	- reverseEnumerate

(void)	- addObjects:

(void)	- addByte:

(void)	- addUByte:

(void)	- addShort:

(void)	- addUShort:

(void)	- addInteger:

(void)	- addUInteger:

(void)	- addLong:

(void)	- addULong:

(void)	- addChar:

(void)	- addUnichar:

(void)	- addCharString:

(void)	- addBool:

(void)	- addFloat:

(void)	- addDouble:

(void)	- addCollection:

(void)	- removeObjectsWithClassName:

(void)	- removeCollection:

(void)	- removeByte:

(void)	- removeUByte:

(void)	- removeShort:

(void)	- removeUShort:

(void)	- removeInteger:

(void)	- removeUInteger:

(void)	- removeLong:

(void)	- removeULong:

(void)	- removeChar:

(void)	- removeUnichar:

(void)	- removeCharString:

(void)	- removeBool:

(void)	- removeFloat:

(void)	- removeDouble:

(void)	- removeObjects:

(BOOL)	- containsByte:

(BOOL)	- containsUByte:

(BOOL)	- containsShort:

(BOOL)	- containsUShort:

(BOOL)	- containsInteger:

(BOOL)	- containsUInteger:

(BOOL)	- containsLong:

(BOOL)	- containsULong:

(BOOL)	- containsChar:

(BOOL)	- containsUnichar:

(BOOL)	- containsCharString:

(BOOL)	- containsBool:

(BOOL)	- containsFloat:

(BOOL)	- containsDouble:

(BOOL)	- containsObjects:

(BOOL)	- containsCollection:

(BOOL)	- containsAnyObject:

(BOOL)	- containsAnyObjectFromCollection:

(BOOL)	- isCollection

(BOOL)	- isLibraryCollection

(BOOL)	- isFoundationCollection

(BOOL)	- isArray

(BOOL)	- isLibraryArray

(BOOL)	- isFoundationArray

(BOOL)	- isSet

(BOOL)	- isLibrarySet

(BOOL)	- isFoundationSet

(BOOL)	- isOrderedSet

(BOOL)	- isLibraryOrderedSet

(BOOL)	- isFoundationOrderedSet

(BOOL)	- isFoundationDictionary

(BOOL)	- isStack

(BOOL)	- isQueue

(BOOL)	- isList

(BOOL)	- isSortable

Instance Methods inherited from SCObject
(id)	- initWithContentsOfSerializedFile:

(BOOL)	- writeContentsToSerializedFile:

(id)	- initWithDataDictionaryFromFile:

(void)	- writeToDataDictionaryFile:atomically:

(void)	- writeToDataDictionaryFile:

(NSDictionary *)	- dataDictionary

(id)	- initWithFileStream:

(void)	- writeToFileStream:

(void)	- appendToFileStream:

Instance Methods inherited from <SCCoding>
Instance Methods inherited from <SCDictionaring>
Instance Methods inherited from <SCCollectioning>
Instance Methods inherited from <SCMutableCollection>
Instance Methods inherited from <SCCollection>
Class Methods inherited from SCCollection
(BOOL)	+ isCollectionClass:

(BOOL)	+ isLibraryCollectionClass:

(BOOL)	+ isFoundationCollectionClass:

(BOOL)	+ isArrayClass:

(BOOL)	+ isLibraryArrayClass:

(BOOL)	+ isFoundationArrayClass:

(BOOL)	+ isSetClass:

(BOOL)	+ isLibrarySetClass:

(BOOL)	+ isFoundationSetClass:

(BOOL)	+ isOrderedSetClass:

(BOOL)	+ isLibraryOrderedSetClass:

(BOOL)	+ isFoundationOrderedSetClass:

(BOOL)	+ isDictionaryClass:

(BOOL)	+ isLibraryDictionaryClass:

(BOOL)	+ isFoundationDictionaryClass:

(BOOL)	+ isStackClass:

(BOOL)	+ isQueueClass:

(BOOL)	+ isListClass:

(BOOL)	+ isSortableClass:

(BOOL)	+ isCollection:

(BOOL)	+ isLibraryCollection:

(BOOL)	+ isFoundationCollection:

(BOOL)	+ isArray:

(BOOL)	+ isLibraryArray:

(BOOL)	+ isFoundationArray:

(BOOL)	+ isSet:

(BOOL)	+ isLibrarySet:

(BOOL)	+ isFoundationSet:

(BOOL)	+ isOrderedSet:

(BOOL)	+ isLibraryOrderedSet:

(BOOL)	+ isFoundationOrderedSet:

(BOOL)	+ isDictionary:

(BOOL)	+ isLibraryDictionary:

(BOOL)	+ isFoundationDictionary:

(BOOL)	+ isStack:

(BOOL)	+ isQueue:

(BOOL)	+ isList:

(BOOL)	+ isSortable:

Properties inherited from SCCollection
NSString *	name

BOOL	readOnly

id< SCCollectionDelegate >	delegate

SCULong	count

BOOL	empty

NSString *	typeName

NSString *	description

NSEnumerator *	objectEnumerator

NSEnumerator *	reverseObjectEnumerator

Properties inherited from <SCCollection>
SCULong	count

BOOL	empty

NSString *	description

SCArray *	array

SCSet *	set

SCOrderedSet *	orderedSet

SCDictionary *	dictionary

SCStack *	stack

SCQueue *	queue

SCUnidirectionalList *	unidirectionalList

SCBidirectionalList *	bidirectionalList

NSArray *	foundationArray

NSSet *	foundationSet

NSOrderedSet *	foundationOrderedSet

NSDictionary *	foundationDictionary

NSEnumerator *	objectEnumerator

Detailed Description

Dictionary class.

Since: version 1.1.3

Implements the collection which uses the keys for access to the objects. Class also supports the data trees.
Class instances can thrown the following exceptions:

Method Documentation

- (SCArray *) allKeysForObject: (id) object

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

Parameters

object - the object to look for in the dictionary

Returns: A new array containing the keys corresponding to all occurrences of the specified object in the dictionary

- (BOOL) boolForKey: (NSString *) key

Returns the boolean value associated with a given key.

Parameters

key	- the key for which to return the corresponding boolean value

Returns: The boolean value associated with a given key or nil if no boolean value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - boolValueForKey:

- (BOOL) boolValueForKey: (NSString *) key

Returns the boolean value associated with a given key.

Parameters

key	- the key for which to return the corresponding boolean value

Returns: The boolean value associated with a given key or nil if no boolean value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: booleanForKey:

- (SCByte) byteForKey: (NSString *) key

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

Parameters

key	- the key for which to return the corresponding value

Returns: The value associated with a given key or nil if no value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - byteValueForKey:

- (SCByte) byteValueForKey: (NSString *) key

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

Parameters

key	- the key for which to return the corresponding value

Returns: The value associated with a given key or nil if no value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - byteForKey:

- (char) charForKey: (NSString *) key

Returns the character associated with a given key.

Parameters

key	- the key for which to return the corresponding character

Returns: The character associated with a given key or nil if no character is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - unicharForKey:; - charValueForKey:; - unicharValueForKey:

- (const char *) charStringForKey: (NSString *) key

Returns the character string associated with a given key.

Parameters

key	- the key for which to return the corresponding character string

Returns: The character string associated with a given key or nil if no character string is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - charStringValueForKey:

- (const char *) charStringValueForKey: (NSString *) key

Returns the character string associated with a given key.

Parameters

key	- the key for which to return the corresponding character string

Returns: The character string associated with a given key or nil if no character string is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - charStringForKey:

- (char) charValueForKey: (NSString *) key

Returns the character associated with a given key.

Parameters

key	- the key for which to return the corresponding character

Returns: The character associated with a given key or nil if no character is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - unicharValueForKey:; - charForKey:; - charValueForKey:

- (BOOL) containsAllObjectsForKeys: (id) keys

Returns a boolean value that indicates whether an objects for all keys from the specified collection of any supported type are present in the receiving dictionary.

Parameters

keys	- the collection with keys

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

- (BOOL) containsAnyObjectForKeys: (id) keys

Returns a boolean value that indicates whether an object for at least one key from the specified collection of any supported type is present in the receiving dictionary.

Parameters

keys	- the collection with keys

Returns: YES if at least one object 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	- the key for the desired number

Returns: YES if a number for the given key is present in 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	- the key for the 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	- the key for the desired string

Returns: YES if a string for the given key is present in the dictionary, otherwise NO

+ (SCDictionary *) dictionary

Creates and returns an unnamed empty dictionary.

Returns: A created dictionary

Reimplemented from SCCollection.

+ (SCDictionary *) dictionaryWithCoder: (NSCoder *) coder

Returns a dictionary created by using the specified coder.

Parameters

coder - the source coder

Returns: A created dictionary

+ (SCDictionary *) dictionaryWithCollection: (id) collection

Returns a dictionary created by using the objects from the specified collection of any supported type.

Parameters

collection - the existing source collection

Returns: A created dictionary

Exceptions

SCCollectionException - collection error detected

+ (SCDictionary *) dictionaryWithContentsOfSerializedFile: (NSString *) path

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

Parameters

path	- the path to the source serialized file

Returns: A created dictionary

+ (SCDictionary *) dictionaryWithDataDictionary: (NSDictionary *) dictionary

Returns a dictionary created by using the specified data dictionary.

Parameters

dictionary - the source data dictionary

Returns: A created dictionary

+ (SCDictionary *) dictionaryWithDataDictionaryFromFile: (NSString *) path

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

Parameters

path	- the path to the source data dictionary file

Returns: A created dictionary

+ (SCDictionary *) dictionaryWithDictionary: (SCDictionary *) dictionary

Creates and returns a dictionary containing keys and objects from another given dictionary.

Parameters

dictionary - a dictionary containing the keys and values with which to initialize the new dictionary

Returns: A new dictionary containing the keys and values found in the specified dictionary

Exceptions

SCCollectionException - collection error detected

+ (SCDictionary *) dictionaryWithFileStream: (NSString *) path

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

Parameters

path	- the path of the source file stream

Returns: A created dictionary

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

+ (SCDictionary *) dictionaryWithName: (NSString *) name

Returns an empty dictionary created by using the specified dictionary name.

Parameters

name	- the dictionary name

Returns: A created dictionary

+ (SCDictionary *) dictionaryWithObject: (id) object

Creates and returns a dictionary containing a given object with the automatic generated key.

Parameters

object - the object to adding into the dictionary

Returns: A new dictionary containing a single object

+ (SCDictionary *) dictionaryWithObject:	(id)	object
forKey:	(NSString *)	key

Creates and returns a dictionary containing a given key and object.

Parameters

object	- the object corresponding to the specified key
key	- the key for the specified object

Returns: A new dictionary containing a single object for a single key

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

Creates and returns a dictionary containing objects from the specified nil terminated list and automatic generated keys.

Parameters

object	- the first object to add to the new dictionary
...	- other objects to add to the new dictionary
NS_REQUIRES_NIL_TERMINATION	- the mandatory nil pointer

Returns: A new dictionary containing the specified objects

+ (SCDictionary *) dictionaryWithObjects:	(id)	objects
forKeys:	(id)	keys

Creates and returns a dictionary containing entries constructed from the contents of a collection of keys and a collection of objects.

Parameters

objects	- a collection containing the objects for the new dictionary
keys	- a collection containing the keys for the new dictionary

Returns: A new dictionary containing entries constructed from the contents of the specified collections

+ (SCDictionary *) dictionaryWithObjectsAndKeys:	(id)	object
,		NS_REQUIRES_NIL_TERMINATION

Creates and returns a dictionary containing entries constructed from the specified set of objects and keys.

Parameters

object	- the first object to add to the new dictionary
...	- first the key for the first object, then a null-terminated list of alternating objects and keys
NS_REQUIRES_NIL_TERMINATION	- the mandatory nil pointer

Returns: A new dictionary

+ (SCDictionary *) dictionaryWithStream: (SCStream *) stream

Returns a dictionary created by using the data from the specified stream.

Parameters

stream - the source stream

Returns: A created dictionary

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

- (SCDouble) doubleForKey: (NSString *) key

Returns the double value associated with a given key.

Parameters

key	- the key for which to return the corresponding double value

Returns: The double value associated with a given key or nil if no double value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - doubleValueForKey:

- (SCDouble) doubleValueForKey: (NSString *) key

Returns the double value associated with a given key.

Parameters

key	- the key for which to return the corresponding double value

Returns: The double value associated with a given key or nil if no double value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - doubleForKey:

- (SCFloat) floatForKey: (NSString *) key

Returns the float value associated with a given key.

Parameters

key	- the key for which to return the corresponding float value

Returns: The float value associated with a given key or nil if no float value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - floatValueForKey:

- (SCFloat) floatValueForKey: (NSString *) key

Returns the float value associated with a given key.

Parameters

key	- the key for which to return the corresponding float value

Returns: The float value associated with a given key or nil if no float value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - floatForKey:

- (id) init

Initializes an empty unnamed dictionary.

Returns: A newly initialized dictionary

- (id) initWithCollection: (id) collection

Initializes a newly allocated dictionary with objects from the specified collection with automatic generated keys.

Parameters

collection - a collection with objects to add to the new dictionary

Returns: An initialized dictionary with the objects from a given collection

Exceptions

SCCollectionException - collection error detected

Reimplemented from SCCollection.

- (id) initWithDictionary: (SCDictionary *) dictionary

Initializes a newly allocated dictionary by placing in it the keys and objects contained in another given dictionary.

Attention: Designed initializer

Parameters

dictionary - a dictionary containing the keys and objects with which to initialize the new dictionary

Returns: An initialized dictionary containing the keys and objects found in the specified source dictionary

Exceptions

SCCollectionException - collection error detected

- (id) initWithName: (NSString *) name

Initializes an empty dictionary using the specified dictionary name.

Attention: Designed initializer

Parameters

name	- the dictionary name

Returns: A newly initialized dictionary

- (id) initWithObject: (id) object

Initializes a newly allocated dictionary containing a given object with the automatic generated key.

Parameters

object - the object to adding into the dictionary

Returns: An initialized dictionary containing a single object

- (id) initWithObject:	(id)	object
forKey:	(NSString *)	key

Initializes a newly allocated dictionary containing a given key and object.

Parameters

object	- the object corresponding to the specified key
key	- the key for the specified object

Returns: An initialized dictionary containing a single object for a single key

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

Initializes a newly allocated dictionary containing objects from the specified nil terminated list and automatic generated keys.

Parameters

object	- the first object to add to the new dictionary
...	- other objects to add to the new dictionary
NS_REQUIRES_NIL_TERMINATION	- the mandatory nil pointer

Returns: An initialized dictionary containing the specified objects

- (id) initWithObjects:	(id)	objects
forKeys:	(id)	keys

Initializes a newly allocated dictionary containing entries constructed from the contents of a collection of keys and a collection of objects.

Parameters

objects	- a collection containing the objects for the new dictionary
keys	- a collection containing the keys for the new dictionary

Returns: An initialized dictionary containing entries constructed from the contents of the specified collections

- (id) initWithObjectsAndKeys:	(id)	object
,		NS_REQUIRES_NIL_TERMINATION

Initializes a newly allocated dictionary with entries constructed from the specified set of objects and keys.

Parameters

object	- the first object to add to the new dictionary
...	- first key for the first object, then a null-terminated list of alternating objects and keys
NS_REQUIRES_NIL_TERMINATION	- the mandatory nil pointer

Returns: An initialized dictionary

- (SCInteger) integerForKey: (NSString *) key

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

Parameters

key	- the key for which to return the corresponding value

Returns: The value associated with a given key or nil if no value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - integerValueForKey:

- (SCInteger) integerValueForKey: (NSString *) key

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

Parameters

key	- the key for which to return the corresponding value

Returns: The value associated with a given key or nil if no value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - integerForKey:

- (BOOL) isEqualToContentsOfDictionary: (SCDictionary *) dictionary

Returns a boolean value that indicates whether the contents of the receiving dictionary are equal to the contents of another given dictionary.

Parameters

dictionary - the dictionary with which to compare the receiving dictionary

Returns: YES if the contents of the specified dictionary are equal to the contents of the receiving dictionary, otherwise NO

- (BOOL) isEqualToDictionary: (SCDictionary *) dictionary

Returns a boolean value that indicates whether the settings and contents of the receiving dictionary are equal to the settings and content of another given dictionary.

Parameters

dictionary - the dictionary with which to compare the receiving dictionary

Returns: YES if the settings and contents of the specified dictionary are equal to the settings and contents of the receiving dictionary, otherwise NO

- (SCLong) longForKey: (NSString *) key

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

Parameters

key	- the key for which to return the corresponding value

Returns: The value associated with a given key or nil if no value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - longValueForKey:

- (SCLong) longValueForKey: (NSString *) key

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

Parameters

key	- the key for which to return the corresponding value

Returns: The value associated with a given key or nil if no value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - longForKey:

- (NSNumber *) numberForKey: (NSString *) key

Returns the number object associated with a given key.

Parameters

key	- the key for which to return the corresponding number object

Returns: The number object associated with the specified key or nil if no number object is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - numberValueForKey:

- (NSNumber *) numberValueForKey: (NSString *) key

Returns the number value associated with a given key.

Parameters

key	- the key for which to return the corresponding number value

Returns: The number value associated with a given key or nil if no number value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - numberForKey:

- (id) objectForKey: (NSString *) key

Returns the object associated with a given key.

Parameters

key	- the key for which to return the corresponding object

Returns: The object associated with the specified key or nil if no object is associated with the key

See also: - valueForKey:

- (void) removeObjectForKey: (NSString *) key

Removes a given key and its associated object from the receiving dictionary.

Parameters

key	- the key to remove

Exceptions

SCCollectionException - collection error detected

- (void) removeObjectsForKeys: (SCArray *) keys

Removes from the receiving dictionary entries specified specified by elements in a given array.

Parameters

keys	- an array of objects specifying the keys to remove

Exceptions

SCCollectionException - collection error detected

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

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

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setBoolValue:forKey:

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

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

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setBool:forKey:

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

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

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setByteValue:forKey:

- (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	- the value for the specified key
key	- the key for the specified value

Exceptions

SCCollectionException - collection error detected

See also: - setByte:forKey:

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

Adds a given character with the specified key to the receiving dictionary.

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setCharValue:forKey:; - setUnichar:forKey:; - setUnicharValue:forKey:

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

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

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setCharStringValue:forKey:

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

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

Parameters

value	- the character string for the specified key
key	- the key for the specified character string

Exceptions

SCCollectionException - collection error detected

See also: - setCharString:forKey:

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

Adds a given character with the specified key to the receiving dictionary.

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setChar:forKey:; - setUnichar:forKey:; - setUnicharValue:forKey:

- (void) setDictionary: (SCDictionary *) dictionary

Sets the settings and contents of the receiving dictionary to settings and entries in a given dictionary.

Parameters

dictionary - the source dictionary

Exceptions

SCCollectionException - collection error detected

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

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

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setDoubleValue:forKey:

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

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

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setDouble:forKey:

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

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

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setFloatValue:forKey:

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

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

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setFloat:forKey:

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

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

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setIntegerValue:forKey:

- (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	- the value for the specified key
key	- the key for the specified value

Exceptions

SCCollectionException - collection error detected

See also: - setInteger:forKey:

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

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

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setLongValue:forKey:

- (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	- the value for the specified key
key	- the key for the specified value

Exceptions

SCCollectionException - collection error detected

See also: - setLong:forKey:

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

Adds a given key-object pair to the dictionary.

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setValue:forKey:

- (void) setObjects:	(id)	objects
forKeys:	(id)	keys

Adds a key-object pairs from the specified collection of the objects and a given collection of the keys.

Parameters

objects	- the collection of the objects
keys	- the collection of the keys

Exceptions

SCCollectionException - collection error detected

- (void) setObjectsAndKeys:	(id)	object
,		NS_REQUIRES_NIL_TERMINATION

Adds into the receiving dictionary entries cotsructed from the specified set of objects and keys.

Parameters

object	- the first object to add to the dictionary
...	- first the key for the first object, then a null-terminated list of alternating objects and keys
NS_REQUIRES_NIL_TERMINATION	- the mandatory nil pointer

Exceptions

SCCollectionException - collection error detected

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

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

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setShortValue:forKey:

- (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	- the value for the specified key
key	- the key for the specified value

Exceptions

SCCollectionException - collection error detected

See also: - setShort:forKey:

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

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

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setUByteValue:forKey:

- (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	- the value for the specified key
key	- the key for the specified value

Exceptions

SCCollectionException - collection error detected

See also: - setUByte:forKey:

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

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

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setUIntegerValue:forKey:

- (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	- the value for the specified key
key	- the key for the specified value

Exceptions

SCCollectionException - collection error detected

See also: - setUInteger:forKey:

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

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

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setULongValue:forKey:

- (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	- the value for the specified key
key	- the key for the specified value

Exceptions

SCCollectionException - collection error detected

See also: - setULong:forKey:

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

Adds a given character with the specified key to the receiving dictionary.

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setUnicharValue:forKey:; - setChar:forKey:; - setCharValue:forKey:

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

Adds a given character with the specified key to the receiving dictionary.

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setUnichar:forKey:; - setChar:forKey:; - setCharValue:forKey:

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

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

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setUShortValue:forKey:

- (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	- the value for the specified key
key	- the key for the specified value

Exceptions

SCCollectionException - collection error detected

See also: - setUShort:forKey:

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

Adds a given key-value pair to the dictionary.

Parameters

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

Exceptions

SCCollectionException - collection error detected

See also: - setObject:forKey:

- (void) setValues:	(id)	values
forKeys:	(id)	keys

Adds a key-value pairs from the specified collection of the values and a given collection of the keys.

Parameters

values	- the collection of the values
keys	- the collection of the keys

Exceptions

SCCollectionException - collection error detected

- (void) setValuesAndKeys:	(id)	object
,		NS_REQUIRES_NIL_TERMINATION

Adds into the receiving dictionary entries cotsructed from the specified set of values and keys.

Parameters

object	- the first value to add to the dictionary
...	- first the key for the first value, then a null-terminated list of alternating values and keys
NS_REQUIRES_NIL_TERMINATION	- the mandatory nil pointer

Exceptions

SCCollectionException - collection error detected

- (SCShort) shortForKey: (NSString *) key

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

Parameters

key	- the key for which to return the corresponding value

Returns: The value associated with a given key or nil if no value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - shortValueForKey:

- (SCShort) shortValueForKey: (NSString *) key

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

Parameters

key	- the key for which to return the corresponding value

Returns: The value associated with a given key or nil if no value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - shortForKey:

- (NSString *) stringForKey: (NSString *) key

Returns the string associated with a given key.

Parameters

key	- the key for which to return the corresponding string

Returns: The string associated with the specified key or nil if no string is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - stringValueForKey:

- (NSString *) stringValueForKey: (NSString *) key

Returns the string associated with a given key.

Parameters

key	- the key for which to return the corresponding string

Returns: The string associated with a given key or nil if no string is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - stringForKey:

- (SCUByte) uByteForKey: (NSString *) key

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

Parameters

key	- the key for which to return the corresponding value

Returns: The value associated with a given key or nil if no value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - uByteValueForKey:

- (SCUByte) uByteValueForKey: (NSString *) key

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

Parameters

key	- the key for which to return the corresponding value

Returns: The value associated with a given key or nil if no value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - uByteForKey:

- (SCUInteger) uIntegerForKey: (NSString *) key

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

Parameters

key	- the key for which to return the corresponding value

Returns: The value associated with a given key or nil if no value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - uIntegerValueForKey:

- (SCUInteger) uIntegerValueForKey: (NSString *) key

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

Parameters

key	- the key for which to return the corresponding value

Returns: The value associated with a given key or nil if no value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - uIntegerForKey:

- (SCULong) uLongForKey: (NSString *) key

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

Parameters

key	- the key for which to return the corresponding value

Returns: The value associated with a given key or nil if no value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - uLongValueForKey:

- (SCULong) uLongValueForKey: (NSString *) key

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

Parameters

key	- the key for which to return the corresponding value

Returns: The value associated with a given key or nil if no value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - uLongForKey:

- (unichar) unicharForKey: (NSString *) key

Returns the character associated with a given key.

Parameters

key	- the key for which to return the corresponding character

Returns: The character associated with a given key or nil if no character is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - charForKey:; - unicharValueForKey:; - charValueForKey:

- (unichar) unicharValueForKey: (NSString *) key

Returns the character associated with a given key.

Parameters

key	- the key for which to return the corresponding character

Returns: The character associated with a given key or nil if no character is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - charValueForKey:; - unicharForKey:; - unicharValueForKey:

- (SCUShort) uShortForKey: (NSString *) key

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

Parameters

key	- the key for which to return the corresponding value

Returns: The value associated with a given key or nil if no value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - uShortValueForKey:

- (SCUShort) uShortValueForKey: (NSString *) key

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

Parameters

key	- the key for which to return the corresponding value

Returns: The value associated with a given key or nil if no value is associated with the key

Exceptions

SCCollectionException - collection error detected

See also: - uShortForKey:

- (id) valueForKey: (NSString *) key

Returns the value associated with a given key.

Parameters

key	- the key for which to return the corresponding value

Returns: The value associated with a given key or nil if no value is associated with the key

See also: - objectForKey:

Property Documentation

- (SCArray *) allKeys

readnonatomicretain

An array containing the all keys in the dictionary, or an empty array if the dictionary has no entries

- (SCArray *) allValues

readnonatomicretain

An array containing the all values in the dictionary, or an empty array if the dictionary has no entries

- (NSEnumerator *) keyEnumerator

readnonatomicretain

An enumerator object that lets you access each key in the dictionary

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

SCDictionary.h
SCDictionary.m

Creating Dictionaries

Initializing Dictionaries

Copying Dictionaries

Comparing Dictionaries

Adding and Changing Objects

Removing Objects

Querying a Dictionary

Finding Objects in a Dictionary

Objects Enumerators

Additional Inherited Members

Detailed Description

Method Documentation

Property Documentation