|
Samond Classes Library 1.1.6-RELEASE build 132
|
Basic configuration class. More...
#import <SCConfig.h>
Basic configuration class.
Class implements the basic functions of the configuration subsystem.
Class was introduced in version 1.2.0.
Class declares the following properties:
| - (void) addAllowedDuplicateKey: | (NSString *) | key |
Adds the specified key into the allowed duplicate list.
| key | - record key |
| - (void) addBoolValue: | (BOOL) | boolValue | |
| forKey: | (NSString *) | key | |
Adds the specified boolean value for a given key.
| boolValue | - boolean value for the specified key |
| key | - a key for the specified boolean value |
| SCConfigException | - configuration error detected |
| - (void) addByteValue: | (SCByte) | byteValue | |
| forKey: | (NSString *) | key | |
Adds the specified signed byte value for a given key.
| byteValue | - signed byte value for the specified key |
| key | - a key for the specified byte value |
| SCConfigException | - configuration error detected |
| - (void) addCharStringValue: | (const char *) | charStringValue | |
| forKey: | (NSString *) | key | |
Add the specified character string value for a given key.
| charStringValue | - character string value for the specified key |
| key | - a key for the specified character string value |
| SCConfigException | - configuration error detected |
| - (void) addCharValue: | (char) | charValue | |
| forKey: | (NSString *) | key | |
Adds the specified char value for a given key.
| charValue | - char value for the specified key |
| key | - a key for the specified char value |
| SCConfigException | - configuration error detected |
| - (void) addConfig: | (SCConfig *) | config | |
| forKey: | (NSString *) | key | |
Adds the specified existing configuration into the receiving configuration as a subconfiguration for a given key.
| config | - added existing configuration |
| key | - added subconfiguration key |
| SCConfigException | - configuration error detected |
| - (void) addDateValue: | (NSDate *) | dateValue | |
| forKey: | (NSString *) | key | |
Adds the specified date value for a given key.
| dateValue | - date value for the specified key |
| key | - a key for the specified date value |
| SCConfigException | - configuration error detected |
| - (void) addDefaultValue: | (id) | value | |
| withType: | (SCConfigRecordType) | type | |
| forKey: | (NSString *) | key | |
Add into the default values list the record with the specified value, type and key.
| value | - default record value |
| type | - default record type |
| key | - default record key |
| - (void) addDefaultValues |
Adds into the receiving configuration the default values if the corresponding records do not exists in the configuration.
| SCConfigException | - configuration error detected |
| - (void) addDoubleValue: | (SCDouble) | doubleValue | |
| forKey: | (NSString *) | key | |
Adds the specified double value for a given key.
| doubleValue | - double value for the specified key |
| key | - a key for the specified double value |
| SCConfigException | - configuration error detected |
| - (void) addFloatValue: | (SCFloat) | floatValue | |
| forKey: | (NSString *) | key | |
Adds the specified float value for a given key.
| floatValue | - float value for the specified key |
| key | - a key for the specified float value |
| SCConfigException | - configuration error detected |
| - (void) addIntValue: | (SCInteger) | intValue | |
| forKey: | (NSString *) | key | |
Adds the specified signed integer value for a given key.
| intValue | - signed integer value for the specified key |
| key | - a key for the specified integer value |
| SCConfigException | - configuration error detected |
| - (void) addKeyName: | (NSString *) | name | |
| forKey: | (NSString *) | key | |
Adds into the key names list the record with the specified new and old keys.
| name | - new name of the configuration key |
| key | - old name of the configuration key |
| - (void) addLongValue: | (SCLong) | longValue | |
| forKey: | (NSString *) | key | |
Adds the specified signed long value for a given key.
| longValue | - signed long value for the specified key |
| key | - a key for the specified long value |
| SCConfigException | - configuration error detected |
| - (void) addMandatoryKey: | (NSString *) | key |
Adds the specified key into the mandatory keys list.
| key | - mandatory key |
| - (void) addNumberValue: | (NSNumber *) | numberValue | |
| forKey: | (NSString *) | key | |
Adds the specified number value for a given key.
| numberValue | - number value for the specified key |
| key | - a key for the specified number value |
| SCConfigException | - configuration error detected |
| - (void) addShortValue: | (SCShort) | shortValue | |
| forKey: | (NSString *) | key | |
Adds the specified signed short value for a given key.
| shortValue | - signed short value for the specified key |
| key | - a key for the specified short value |
| SCConfigException | - configuration error detected |
| - (void) addString: | (NSString *) | string |
Adds the configuration record created by using the specified configuration string.
| string | - configuration string |
| SCConfigException | - configuration error detected |
| - (void) addStringValue: | (NSString *) | stringValue | |
| forKey: | (NSString *) | key | |
Adds the specified string value for a given key.
| stringValue | - string value for the specified key |
| key | - a key for the specified string value |
| SCConfigException | - configuration error detected |
| - (void) addUnicharValue: | (unichar) | unicharValue | |
| forKey: | (NSString *) | key | |
Adds the specified unichar value for a given key.
| unicharValue | - unichar value for the specified key |
| key | - a key for the specified char value |
| SCConfigException | - configuration error detected |
| - (void) addUnsignedByteValue: | (SCUByte) | unsignedByteValue | |
| forKey: | (NSString *) | key | |
Adds the specified unsigned byte value for a given key.
| unsignedByteValue | - unsigned byte value for the specified key |
| key | - a key for the specified unsigned byte value |
| SCConfigException | - configuration error detected |
| - (void) addUnsignedIntValue: | (SCUInteger) | unsignedIntValue | |
| forKey: | (NSString *) | key | |
Adds the specified unsigned integer value for a given key.
| unsignedIntValue | - unsigned integer value for the specified key |
| key | - a key for the specified unsigned integer value |
| SCConfigException | - configuration error detected |
| - (void) addUnsignedLongValue: | (SCULong) | unsignedLongValue | |
| forKey: | (NSString *) | key | |
Adds the specified unsigned long value for a given key.
| unsignedLongValue | - unsigned long value for the specified key |
| key | - a key for the specified unsigned long value |
| SCConfigException | - configuration error detected |
| - (void) addUnsignedShortValue: | (SCUShort) | unsignedShortValue | |
| forKey: | (NSString *) | key | |
Adds the specified unsigned short value for a given key.
| unsignedShortValue | - unsigned short value for the specified key |
| key | - a key for the specified unsigned short value |
| SCConfigException | - configuration error detected |
| - (void) addValidKey: | (NSString *) | key |
Adds the specified key into the valid keys list.
| key | - valid key |
| - (void) addValidType: | (SCConfigRecordType) | type | |
| forKey: | (NSString *) | key | |
Adds the record with the specified type and key into the valid types list.
| type | - valid type |
| key | - record type |
| - (void) addValidValue: | (id) | value | |
| forKey: | (NSString *) | key | |
Adds the record with the specified value and key into the valid values list.
| value | - valid value |
| key | - record type |
| - (void) addValue: | (id) | value | |
| forKey: | (NSString *) | key | |
Adds the specified value for a given key.
| value | - a value for the specified key |
| key | - a key for the specified value |
| SCConfigException | - configuration error detected |
| - (void) addValuesFromCollection: | (id) | collection |
Adds into the receiving configuration records from the specified existing collection.
| collection | - existing source collection |
| SCConfigException | - configuration error detected |
| - (void) addValuesFromConfig: | (SCConfig *) | config |
Adds into the receiving configuration records from the specified existing configuration.
| config | - existing source configuration |
| SCConfigException | - configuration error detected |
| - (void) addValuesFromText: | (SCStrings *) | text |
Adds into the receiving configuration records from the specified existing strings list.
| text | - existing source strings list |
| SCConfigException | - configuration error detected |
| - (SCArray *) allKeys |
Returns the array with the all keys from the receiving configuration.
| - (SCArray *) array |
Returns the array with the receiving configuration records.
| - (BOOL) boolValueForKey: | (NSString *) | key |
Returns the boolean value assodicated with a given key.
| key | - the key for which to return the corresponding value |
| SCConfigException | - configuration error detected |
| - (SCULong) boolValuesCount |
Returns a count of the boolean values in the receiving configuration.
| - (SCByte) byteValueForKey: | (NSString *) | key |
Returns the signed byte value assodicated with a given key.
| key | - the key for which to return the corresponding value |
| SCConfigException | - configuration error detected |
| - (BOOL) caseInsensitive |
Determines whether the receiving configuration ignores or not case in the records keys.
| - (const char *) charStringValueForKey: | (NSString *) | key |
Returns the character string value assodicated with a given key.
| key | - the key for which to return the corresponding value |
| SCConfigException | - configuration error detected |
| - (char) charValueForKey: | (NSString *) | key |
Returns the char value assodicated with a given key.
| key | - the key for which to return the corresponding value |
| SCConfigException | - configuration error detected |
| - (BOOL) checkMandatoryKeys |
Checks the receiving configuration for required keys.
| SCConfigException | - configuration error detected |
| + (SCConfig *) config |
Returns the configuration created by using the default properties.
Reimplemented in SCConfigFile.
| - (SCConfig *) configForKey: | (NSString *) | key |
Returns the subconfiguration for a given key.
| key | - required subconfiguration key |
| - (SCULong) configValuesCount |
Returns a count of the subconfigurations in the receiving configuration.
| + (SCConfig *) configWithCoder: | (NSCoder *) | coder |
Returns the configuration created by using the specified coder.
| coder | - source coder |
| + (SCConfig *) configWithCollection: | (id) | collection |
Returns the configuration created by using the specified existing collection.
| collection | - existing source collection |
| SCConfigException | - configuration error detected |
Returns the configuration created by using the specified existing configuration.
| config | - existing source configuration |
| SCConfigException | - configuration error detected |
| + (SCConfig *) configWithContentsOfSerializedFile: | (NSString *) | path |
Returns the configuration created by using the contents of serialized file with the specified path.
| path | - source serialized file path |
| + (SCConfig *) configWithDataDictionary: | (NSDictionary *) | dictionary |
Returns the configuration created by using the specified dictionary.
| dictionary | - source dictionary |
| + (SCConfig *) configWithDataDictionaryFromFile: | (NSString *) | path |
Returns the configuration created by using the dictionary from the specified file.
| path | - source dictionary file path |
| + (SCConfig *) configWithFileStream: | (NSString *) | path |
Returns the configuration created from the stream file with the specified path.
| path | - stream file path |
| SCStreamException | - stream operation error detected |
| SCSystemException | - system error detected |
| + (SCConfig *) configWithName: | (NSString *) | name |
Returns the configuration created by using the specified configuration name.
| name | - configuration name |
| + (SCConfig *) configWithName: | (NSString *) | name | |
| delegate: | (id<SCConfigDelegate>) | delegate | |
| unique: | (BOOL) | unique | |
| caseInsensitive: | (BOOL) | caseInsensitive | |
| ignoreErrors: | (BOOL) | ignoreErrors | |
| autoCreate: | (BOOL) | autoCreate | |
Returns the configuration created by using the specified configuration name, delegate object, key duplicate allowing flag, case insensitive flag, detected error ignoring flag and subconfiguration auto creation flag.
| name | - configuration name |
| delegate | - delegate object |
| unique | - NO for allowing key duplication, YES for disabling key duplication |
| caseInsensitive | - YES for case insensitive key oprations, NO for case sensitive operations |
| ignoreErrors | - YES for ignoring detected errors, NO for throw exception if error detected |
| autoCreate | - YES for allowing automatic subsconfiguration creation, NO for disabling |
| + (SCConfig *) configWithName: | (NSString *) | name | |
| string: | (NSString *) | string | |
Returns the configuration created by using the specified configuration name and record with the configuration string.
| name | - configuration name |
| string | - string with the configuration record |
| SCConfigException | - configuration error detected |
| + (SCConfig *) configWithName: | (NSString *) | name | |
| strings: | (NSString *) | string | |
| , | ... | ||
Returns the configuration created by using the specified configuration name and null terminated list with the configuration strings.
| name | - configuration name |
| string | - first string with the configuration record |
| ... | - other strings with the configuration records |
| SCConfigException | - configuration error detected |
Returns the configuration created from the specified stream.
| stream | - stream for reading configuration |
| SCStreamException | - stream operation error detected |
| SCSystemException | - system error detected |
| + (SCConfig *) configWithString: | (NSString *) | string |
Returns the configuration created by using the specified string with the configuration record.
| string | - string with the configuration record |
| SCConfigException | - configuration error detected |
| + (SCConfig *) configWithStrings: | (NSString *) | string | |
| , | ... | ||
Returns the configuration created by using the specified null terminated list with the configuration strings.
| string | - first string with the configuration record |
| ... | - other strings with the configuration records |
| SCConfigException | - configuration error detected |
Returns the configuration created by using the specified existing strings list.
| text | - existing source strings list |
| SCConfigException | - configuration error detected |
| - (BOOL) containsBoolValue: | (BOOL) | boolValue |
Returns a boolean value that indicates whether a given boolean value is present in the receiving configuration.
| boolValue | - boolean value |
| - (BOOL) containsBoolValue: | (BOOL) | boolValue | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a given boolean value with the specified key is present in the receiving configuration.
| boolValue | - boolean value for the key |
| key | - key for the boolean value |
| - (BOOL) containsBoolValueForKey: | (NSString *) | key |
Returns a boolean value that indicates whether a boolean value with the specified key is present in the receiving configuration.
| key | - key for the boolean value |
| - (BOOL) containsByteValue: | (SCByte) | byteValue |
Returns a boolean value that indicates whether a given signed byte value is present in the receiving configuration.
| byteValue | - signed byte value |
| - (BOOL) containsByteValue: | (SCByte) | byteValue | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a given signed byte value with the specified key is present in the receiving configuration.
| byteValue | - signed byte value for the key |
| key | - key for the signed byte value |
| - (BOOL) containsCharStringValue: | (const char *) | charStringValue |
Returns a boolean value that indicates whether a given char string value is present in the receiving configuration.
| charStringValue | - char string value |
| - (BOOL) containsCharStringValue: | (const char *) | charStringValue | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a given character string value with the specified key is present in the receiving configuration.
| charStringValue | - character string value for the key |
| key | - key for the character string value |
| - (BOOL) containsCharValue: | (char) | charValue |
Returns a boolean value that indicates whether a given char value is present in the receiving configuration.
| charValue | - char value |
| - (BOOL) containsCharValue: | (char) | charValue | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a given char value with the specified key is present in the receiving configuration.
| charValue | - char value for the key |
| key | - key for the char value |
| - (BOOL) containsConfigForKey: | (NSString *) | key |
Returns a boolean value that determines whether the subconfiguration with a given key is present in the receiving configuration.
| key | - required subconfiguration key |
| - (BOOL) containsDateValue: | (NSDate *) | dateValue |
Returns a boolean value that indicates whether a given date value is present in the receiving configuration.
| dateValue | - date value |
| - (BOOL) containsDateValue: | (NSDate *) | dateValue | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a given date value with the specified key is present in the receiving configuration.
| dateValue | - date value for the key |
| key | - key for the date value |
| - (BOOL) containsDateValueForKey: | (NSString *) | key |
Returns a boolean value that indicates whether a date value with the specified key is present in the receiving configuration.
| key | - key for the boolean value |
| - (BOOL) containsDefaultValueForKey: | (NSString *) | key |
Returns a boolean value that indicates whether a record with a given key is present in the default values list.
| key | - default value key |
| - (BOOL) containsDoubleValue: | (SCDouble) | doubleValue |
Returns a boolean value that indicates whether a given double value is present in the receiving configuration.
| doubleValue | - double value |
| - (BOOL) containsDoubleValue: | (SCDouble) | doubleValue | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a given double value with the specified key is present in the receiving configuration.
| doubleValue | - double value for the key |
| key | - key for the double value |
| - (BOOL) containsDuplicateKey: | (NSString *) | key |
Returns a boolean value that indicates whether a given key is present in the allowed duplicate list.
| key | - checked key |
| - (BOOL) containsFloatValue: | (SCFloat) | floatValue |
Returns a boolean value that indicates whether a given float value is present in the receiving configuration.
| floatValue | - float value |
| - (BOOL) containsFloatValue: | (SCFloat) | floatValue | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a given float value with the specified key is present in the receiving configuration.
| floatValue | - float value for the key |
| key | - key for the float value |
| - (BOOL) containsIntValue: | (SCInteger) | intValue |
Returns a boolean value that indicates whether a given signed integer value is present in the receiving configuration.
| intValue | - signed integer value |
| - (BOOL) containsIntValue: | (SCInteger) | intValue | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a given signed integer value with the specified key is present in the receiving configuration.
| intValue | - signed integer value for the key |
| key | - key for the signed integer value |
| - (BOOL) containsLongValue: | (SCLong) | longValue |
Returns a boolean value that indicates whether a given signed long value is present in the receiving configuration.
| longValue | - signed long value |
| - (BOOL) containsLongValue: | (SCLong) | longValue | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a given signed long value with the specified key is present in the receiving configuration.
| longValue | - signed long value for the key |
| key | - key for the signed long value |
| - (BOOL) containsMandatoryKey: | (NSString *) | key |
Returns a boolean value that indicates whether a given key is present in the mandatory keys list.
| key | - checked key |
| - (BOOL) containsNameForKey: | (NSString *) | key |
Returns a boolean value that indicates whether a given key is present in the key names list.
| key | - original key name |
| - (BOOL) containsNumberValue: | (NSNumber *) | numberValue |
Returns a boolean value that indicates whether a given number value is present in the receiving configuration.
| numberValue | - number value |
| - (BOOL) containsNumberValue: | (NSNumber *) | numberValue | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a given number value with the specified key is present in the receiving configuration.
| numberValue | - number value for the key |
| key | - key for the number value |
| - (BOOL) containsNumberValueForKey: | (NSString *) | key |
Returns a boolean value that indicates whether a number value with the specified key is present in the receiving configuration.
| key | - key for the number value |
| - (BOOL) containsShortValue: | (SCShort) | shortValue |
Returns a boolean value that indicates whether a given signed short value is present in the receiving configuration.
| shortValue | - signed short value |
| - (BOOL) containsShortValue: | (SCShort) | shortValue | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a given signed short value with the specified key is present in the receiving configuration.
| shortValue | - signed short value for the key |
| key | - key for the signed short value |
| - (BOOL) containsStringValue: | (NSString *) | stringValue |
Returns a boolean value that indicates whether a given string value is present in the receiving configuration.
| stringValue | - string value |
| - (BOOL) containsStringValue: | (NSString *) | stringValue | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a given string value with the specified key is present in the receiving configuration.
| stringValue | - string value for the key |
| key | - key for the string value |
| - (BOOL) containsStringValueForKey: | (NSString *) | key |
Returns a boolean value that indicates whether a string value with the specified key is present in the receiving configuration.
| key | - key for the string value |
| - (BOOL) containsUnicharValue: | (unichar) | unicharValue |
Returns a boolean value that indicates whether a given unichar value is present in the receiving configuration.
| unicharValue | - unichar value |
| - (BOOL) containsUnicharValue: | (unichar) | unicharValue | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a given unichar value with the specified key is present in the receiving configuration.
| unicharValue | - unichar value for the key |
| key | - key for the unichar value |
| - (BOOL) containsUnsignedByteValue: | (SCUByte) | unsignedByteValue |
Returns a boolean value that indicates whether a given unsigned byte value is present in the receiving configuration.
| unsignedByteValue | - unsigned byte value |
| - (BOOL) containsUnsignedByteValue: | (SCUByte) | unsignedByteValue | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a given unsigned byte value with the specified key is present in the receiving configuration.
| unsignedByteValue | - unsigned byte value for the key |
| key | - key for the unsigned byte value |
| - (BOOL) containsUnsignedIntValue: | (SCUInteger) | unsignedIntValue |
Returns a boolean value that indicates whether a given unsigned integer value is present in the receiving configuration.
| unsignedIntValue | - unsigned integer value |
| - (BOOL) containsUnsignedIntValue: | (SCUInteger) | unsignedIntValue | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a given unsigned integer value with the specified key is present in the receiving configuration.
| unsignedIntValue | - unsigned integer value for the key |
| key | - key for the unsigned integer value |
| - (BOOL) containsUnsignedLongValue: | (SCULong) | unsignedLongValue |
Returns a boolean value that indicates whether a given unsigned long value is present in the receiving configuration.
| unsignedLongValue | - unsigned long value |
| - (BOOL) containsUnsignedLongValue: | (SCULong) | unsignedLongValue | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a given unsigned long value with the specified key is present in the receiving configuration.
| unsignedLongValue | - unsigned long value for the key |
| key | - key for the unsigned long value |
| - (BOOL) containsUnsignedShortValue: | (SCUShort) | unsignedShortValue |
Returns a boolean value that indicates whether a given unsigned short value is present in the receiving configuration.
| unsignedShortValue | - unsigned short value |
| - (BOOL) containsUnsignedShortValue: | (SCUShort) | unsignedShortValue | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a given unsigned short value with the specified key is present in the receiving configuration.
| unsignedShortValue | - unsigned short value for the key |
| key | - key for the unsigned short value |
| - (BOOL) containsValidKey: | (NSString *) | key |
Returns a boolean value that indicates whether a given key is present in the valid keys list.
| key | - checked key |
| - (BOOL) containsValidType: | (SCConfigRecordType) | type | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a record with the specified type and key is present in the valid types list.
| type | - record type |
| key | - record key |
| - (BOOL) containsValidTypesForKey: | (NSString *) | key |
Returns a boolean value that indicates whether a record for the specified key is present in the valid types list.
| key | - record key |
| - (BOOL) containsValidValue: | (id) | value | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a record with the specified value and key is present in the valid vaslues list.
| value | - record value |
| key | - record key |
| - (BOOL) containsValidValuesForKey: | (NSString *) | key |
Returns a boolean value that indicates whether a record for the specified key is present in the valid values list.
| key | - record key |
| - (BOOL) containsValue: | (id) | value |
Returns a boolean value that indicates whether a given value is present in the receiving configuration.
| value | - record value |
| - (BOOL) containsValue: | (id) | value | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates whether a given value with the specified key is present in the receiving configuration.
| value | - value for the key |
| key | - key for the value |
| - (BOOL) containsValueForKey: | (NSString *) | key |
Returns a boolean value that indicates whether a record with the specified key is present in the receiving configuration.
| key | - record key |
| - (SCULong) count |
Returns the count of configuration records on the top level. Records from the subconfigurations do not processing.
| - (SCULong) countBoolValue: | (BOOL) | boolValue |
Returns a count of the specified boolean values in the receiving configuration.
| boolValue | - boolean value |
| - (SCULong) countBoolValuesForKey: | (NSString *) | key |
Returns a count of the boolean values for the specified key in the receiving configuration.
| key | - boolean values key |
Returns a count of the specified signed byte values in the receiving configuration.
| byteValue | - signed byte value |
| - (SCULong) countCharStringValue: | (const char *) | charStringValue |
Returns a count of the specified character string values in the receiving configuration.
| charStringValue | - character string value |
| - (SCULong) countCharValue: | (char) | charValue |
Returns a count of the specified char values in the receiving configuration.
| charValue | - char value |
| - (SCULong) countDateValue: | (NSDate *) | dateValue |
Returns a count of the specified date values in the receiving configuration.
| dateValue | - date value |
| - (SCULong) countDateValuesForKey: | (NSString *) | key |
Returns a count of the date values for the specified key in the receiving configuration.
| key | - date values key |
Returns a count of the specified double values in the receiving configuration.
| doubleValue | - double value |
Returns a count of the specified float values in the receiving configuration.
| floatValue | - float value |
Returns a count of the specified signed integer values in the receiving configuration.
| intValue | - signed integer value |
Returns a count of the specified signed long values in the receiving configuration.
| longValue | - signed long value |
| - (SCULong) countNumberValue: | (NSNumber *) | numberValue |
Returns a count of the specified number values in the receiving configuration.
| numberValue | - number value |
| - (SCULong) countNumberValuesForKey: | (NSString *) | key |
Returns a count of the number values for the specified key in the receiving configuration.
| key | - number values key |
Returns a count of the specified signed short values in the receiving configuration.
| shortValue | - signed short value |
| - (SCULong) countStringValue: | (NSString *) | stringValue |
Returns a count of the specified string values in the receiving configuration.
| stringValue | - string value |
| - (SCULong) countStringValuesForKey: | (NSString *) | key |
Returns a count of the string values for the specified key in the receiving configuration.
| key | - string values key |
| - (SCULong) countUnicharValue: | (unichar) | unicharValue |
Returns a count of the specified unichar values in the receiving configuration.
| unicharValue | - unichar value |
Returns a count of the specified unsigned byte values in the receiving configuration.
| unsignedByteValue | - unsigned byte value |
| - (SCULong) countUnsignedIntValue: | (SCUInteger) | unsignedIntValue |
Returns a count of the specified unsigned integer values in the receiving configuration.
| unsignedIntValue | - unsigned integer value |
Returns a count of the specified unsigned long values in the receiving configuration.
| unsignedLongValue | - unsigned long value |
Returns a count of the specified unsigned short values in the receiving configuration.
| unsignedShortValue | - unsigned short value |
| - (SCULong) countValue: | (id) | value |
Returns a count of the specified values in the receiving configuration.
| value | - configuration value |
| - (SCULong) countValuesForKey: | (NSString *) | key |
Returns a count of the values for the specified key in the receiving configuration.
| key | - record key |
| - (void) createConfigForKey: | (NSString *) | key |
Creates the subconfiguration with the specified key.
| key | - created subconfiguration key |
| SCConfigException | - configuration error detected |
| - (NSDate *) dateValueForKey: | (NSString *) | key |
Returns the date value assodicated with a given key.
| key | - the key for which to return the corresponding value |
| SCConfigException | - configuration error detected |
| - (SCULong) dateValuesCount |
Returns a count of the date values in the receiving configuration.
| - (SCConfigRecordType) defaultTypeForKey: | (NSString *) | key |
Returns the default type for the specified key.
| key | - the key for which to get the default type |
| - (id) defaultValueForKey: | (NSString *) | key |
Returns the default value for the specified key.
| key | - the key for which to get the default value |
| - (SCArray *) defaultValues |
Returns the list of the configuration default values.
| - (id< SCConfigDelegate >) delegate |
Returns the receiving configuration delegate object.
| - (NSString *) description |
Returns a string which represents the configuration information.
Reimplemented in SCConfigFile.
| - (SCDictionary *) dictionary |
Returns the dictionary with the receiving configuration records. If the receiving configuration contains more than one record with the same key, in the resulting dictionary sets only one of the records.
| - (SCDouble) doubleValueForKey: | (NSString *) | key |
Returns the double value assodicated with a given key.
| key | - the key for which to return the corresponding value |
| SCConfigException | - configuration error detected |
| - (SCArray *) duplicatedKeys |
Returns the list of keys that can be duplicates in the receiving configuration.
| - (SCConfigException *) error |
Returns the receiving configuration last detected error.
| - (SCFloat) floatValueForKey: | (NSString *) | key |
Returns the float value assodicated with a given key.
| key | - the key for which to return the corresponding value |
| SCConfigException | - configuration error detected |
| - (NSArray *) foundationArray |
Returns the foundation array with the receiving configuration records.
| - (NSDictionary *) foundationDictionary |
Returns the foundation dictionary with the receiving configuration records. If the receiving configuration contains more than one record with the same key, in the resulting foundation dictionary sets only one of the records.
| - (SCULong) fullCount |
Returns the count of all configuration records including records from all subconfigurations.
| - (id) init |
Initializes the configuration with the default properties.
| - (id) initWithCollection: | (id) | collection |
Initializes the configuration using the specified existing collection.
| collection | - existing source collection |
| SCConfigException | - configuration error detected |
| - (id) initWithConfig: | (SCConfig *) | config |
Initializes the configuration using the specified existing configuration.
| config | - existing source configuration |
| SCConfigException | - configuration error detected |
| - (id) initWithName: | (NSString *) | name |
Initializes the configuration using the specified name.
| name | - configuration name |
| - (id) initWithName: | (NSString *) | name | |
| delegate: | (id<SCConfigDelegate>) | delegate | |
| unique: | (BOOL) | unique | |
| caseInsensitive: | (BOOL) | caseInsensitive | |
| ignoreErrors: | (BOOL) | ignoreErrors | |
| autoCreate: | (BOOL) | autoCreate | |
Initializes the configuration using the specified configuration name, delegate object, key duplicate allowing flag, case insensitive flag, detected error ignoring flag and subconfiguration auto creation flag.
| name | - configuration name |
| delegate | - delegate object |
| unique | - NO for allowing key duplication, YES for disabling key duplication |
| caseInsensitive | - YES for case insensitive key oprations, NO for case sensitive operations |
| ignoreErrors | - YES for ignoring detected errors, NO for throw exception if error detected |
| autoCreate | - YES for allowing automatic subsconfiguration creation, NO for disabling |
| - (id) initWithName: | (NSString *) | name | |
| string: | (NSString *) | string | |
Initializes the configuration using the specified configuration name and string with the configuration record.
| name | - configuration name |
| string | - string with the configuration record |
| SCConfigExcpetion | - configuration error detected |
| - (id) initWithName: | (NSString *) | name | |
| strings: | (NSString *) | string | |
| , | ... | ||
Initializes the configuration using the specified configuration name and null terminated list of the configuration strings.
| name | - configuration name |
| string | - first string with the configuration record |
| ... | - other strings with the configuration records |
| SCConfigException | - configuration error detected |
| - (id) initWithString: | (NSString *) | string |
Initializes the configuration using the specified string with the configuration record.
| string | - string with the configuration record |
| SCConfigException | - configuration error detected |
| - (id) initWithStrings: | (NSString *) | string | |
| , | ... | ||
Initializes the configuration using the specified null terminated list of the configuration strings.
| string | - first string with the configuration record |
| ... | - other strings with the configuration records |
| SCConfigException | - configuration error detected |
| - (id) initWithText: | (SCStrings *) | text |
Initializes the configuration using the specified existing strings list.
| text | - existing source strings list |
| SCConfigException | - configuration error detected |
| - (SCInteger) intValueForKey: | (NSString *) | key |
Returns the signed integer value assodicated with a given key.
| key | - the key for which to return the corresponding value |
| SCConfigException | - configuration error detected |
| - (BOOL) isAllowedDuplicateValueForKey: | (NSString *) | key |
Returns a boolean value that determines the permission of duplicating record with the specified key.
| key | - record key |
| - (BOOL) isAutoCreate |
Determines whether the receiving configuration allows subconfigurations automatic creation.
| - (BOOL) isBoolValueForKey: | (NSString *) | key |
Returns a boolean value which determines whether the record with a specified key is a boolean record.
| key | - checked record key |
| SCConfigException | - configuration error detected |
| - (BOOL) isConfigValueForKey: | (NSString *) | key |
Returns a boolean value which determines whether the record with a specified key is a subconfiguration.
| key | - checked record key |
| SCConfigException | - configuration error detected |
| - (BOOL) isDateValueForKey: | (NSString *) | key |
Returns a boolean value which determines whether the record with a specified key is a date record.
| key | - checked record key |
| SCConfigException | - configuration error detected |
| - (BOOL) isEmpty |
Returns a boolean value that determines whether the receiving configuration is empty or contains at least one top-level record.
| - (BOOL) isEqual: | (id) | object |
Returns a boolean value that indicates whether the receiving configuration are equal to the specified object.
| object | - the object with which to compare the receiving configuration |
Reimplemented from SCObject.
| - (BOOL) isEqualTo: | (id) | object |
Returns a boolean value that indicates whether the receiving configuration are equal to the specified object.
| object | - the object with which to compare the receiving configuration |
| - (BOOL) isEqualToCollection: | (id) | collection |
Returns a boolean value that indicates whether the contents of the receiving configuration are equal to the contents of a given collection.
| collection | - the collection with which to compare the receiving configuration |
| - (BOOL) isEqualToConfig: | (SCConfig *) | config |
Returns a boolean value that indicates whether the receiving configuration are equal to the another given configuration.
| config | - the configuration with which to compare the receiving configuration |
| - (BOOL) isEqualToContentOfConfig: | (SCConfig *) | config |
Returns a boolean value that indicates whether the contents of the receiving configuration are equal to the contents of another given configuration.
| config | - the configuration with which to compare the receiving configuration |
| - (BOOL) isEqualToText: | (SCStrings *) | text |
Returns a boolean value that indicates whether the contents of the receiving configuration are equal to the specified text.
| text | - the text with which to compare the receiving configuration |
| - (BOOL) isIgnoreErrors |
Determines whether the receiving configuration ignores the detected errors or throws exceptions.
| - (BOOL) isModified |
Determines whether the receiving configuration has any modifications.
| - (BOOL) isNumberValueForKey: | (NSString *) | key |
Returns a boolean value which determines whether the record with a specified key is a number record.
| key | - checked record key |
| SCConfigException | - configuration error detected |
| - (BOOL) isReadOnly |
Returns a boolean value that determines whether the receiving configuration allows any changes.
| - (BOOL) isStringValueForKey: | (NSString *) | key |
Returns a boolean value which determines whether the record with a specified key is a string record.
| key | - checked record key |
| SCConfigException | - configuration error detected |
| - (BOOL) isUnique |
Determines whether the receiving configuration allows records with the duplicated keys.
| - (BOOL) isValidConfigForKey: | (NSString *) | key |
Returns a boolean value which determines the ability of adding the subconfiguration with the specified key.
| key | - subconfiguration key |
| - (BOOL) isValidKey: | (NSString *) | key |
Returns a boolean value that indicates ability of a given local key.
| key | - local key |
| - (BOOL) isValidType: | (SCConfigRecordType) | type | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates ability of a given type for the specified key.
| type | - value type |
| key | - value key |
| - (BOOL) isValidValue: | (id) | value | |
| forKey: | (NSString *) | key | |
Returns a boolean value that indicates ability of a given value for the specified key.
| value | - checked value |
| key | - value key |
| - (NSEnumerator *) keyEnumerator |
Returns an enumerator object that lets you access each key in the receiving configuration.
| - (NSString *) keyForBoolValue: | (BOOL) | boolValue |
Returns the first key which corresponding with the specified boolean value.
| boolValue | - the boolean value for which to return the corresponding key |
| - (NSString *) keyForByteValue: | (SCByte) | byteValue |
Returns the first key which corresponding with the specified signed byte value.
| byteValue | - the signed byte value for which to return the corresponding key |
| - (NSString *) keyForCharString: | (const char *) | charStringValue |
Returns the first key which corresponding with the specified char string value.
| charStringValue | - the char string value for which to return the corresponding key |
| - (NSString *) keyForCharValue: | (char) | charValue |
Returns the first key which corresponding with the specified char value.
| charValue | - the char value for which to return the corresponding key |
| - (NSString *) keyForDateValue: | (NSDate *) | dateValue |
Returns the first key which corresponding with the specified date value.
| dateValue | - the date value for which to return the corresponding key |
| - (NSString *) keyForDoubleValue: | (SCDouble) | doubleValue |
Returns the first key which corresponding with the specified double value.
| doubleValue | - the double value for which to return the corresponding key |
| - (NSString *) keyForFloatValue: | (SCFloat) | floatValue |
Returns the first key which corresponding with the specified float value.
| floatValue | - the float value for which to return the corresponding key |
| - (NSString *) keyForIntValue: | (SCInteger) | intValue |
Returns the first key which corresponding with the specified signed integer value.
| intValue | - the signed integer value for which to return the corresponding key |
| - (NSString *) keyForLongValue: | (SCLong) | longValue |
Returns the first key which corresponding with the specified signed long value.
| longValue | - the signed long value for which to return the corresponding key |
| - (NSString *) keyForNumberValue: | (NSNumber *) | numberValue |
Returns the first key which corresponding with the specified number value.
| numberValue | - the number value for which to return the corresponding key |
| - (NSString *) keyForShortValue: | (SCShort) | shortValue |
Returns the first key which corresponding with the specified signed short value.
| shortValue | - the signed short value for which to return the corresponding key |
| - (NSString *) keyForStringValue: | (NSString *) | stringValue |
Returns the first key which corresponding with the specified string value.
| stringValue | - the string value for which to return the corresponding key |
| - (NSString *) keyForUnicharValue: | (unichar) | unicharValue |
Returns the first key which corresponding with the specified unichar value.
| unicharValue | - the unichar value for which to return the corresponding key |
| - (NSString *) keyForUnsignedByteValue: | (SCUByte) | unsignedByteValue |
Returns the first key which corresponding with the specified unsigned byte value.
| unsignedByteValue | - the unsigned byte value for which to return the corresponding key |
| - (NSString *) keyForUnsignedIntValue: | (SCUInteger) | unsignedIntValue |
Returns the first key which corresponding with the specified unsigned integer value.
| unsignedIntValue | - the unsigned integer value for which to return the corresponding key |
| - (NSString *) keyForUnsignedLongValue: | (SCULong) | unsignedLongValue |
Returns the first key which corresponding with the specified unsigned long value.
| unsignedLongValue | - the unsigned long value for which to return the corresponding key |
| - (NSString *) keyForUnsignedShortValue: | (SCUShort) | unsignedShortValue |
Returns the first key which corresponding with the specified unsigned short value.
| unsignedShortValue | - the unsigned short value for which to return the corresponding key |
| - (NSString *) keyForValue: | (id) | value |
Returns the first key which corresponding with the specified value.
| value | - the value for which to return the corresponding key |
| - (NSString *) keyNameForKey: | (NSString *) | key |
Returns the configuration key name for the specified existing key.
| key | - existing configuration key name |
| - (SCArray *) keyNames |
Returns the keys substitution list.
| - (SCLong) longValueForKey: | (NSString *) | key |
Returns the signed long value assodicated with a given key.
| key | - the key for which to return the corresponding value |
| SCConfigException | - configuration error detected |
| - (SCArray *) mandatoryKeys |
Returns the list of the mandatory configuration keys.
| - (NSString *) name |
Returns the receiving configuration name.
| - (NSString *) nameForKey: | (NSString *) | key |
Returns the new name of the specified configuration key.
| key | - existing key |
| - (NSNumber *) numberValueForKey: | (NSString *) | key |
Returns the number value assodicated with a given key.
| key | - the key for which to return the corresponding value |
| SCConfigException | - configuration error detected |
| - (SCULong) numberValuesCount |
Returns a count of the number values in the receiving configuration.
| - (void) removeAllowedDuplicateKeys |
Removes all records from the duplicated keys list.
| - (void) removeAllValues |
Removes all records from the receiving configuration.
| SCConfigException | - configuration error detected |
| - (void) removeBoolValue: | (BOOL) | boolValue | |
| forKey: | (NSString *) | key | |
Removes from the receiving configuration the record with the specified boolean value and key.
| boolValue | - removed boolean value |
| key | - removed key |
| SCConfigException | - configuration error detected |
| - (void) removeByteValue: | (SCByte) | byteValue | |
| forKey: | (NSString *) | key | |
Removes from the receiving configuration the record with the specified signed byte value and key.
| byteValue | - removed signed byte value |
| key | - removed key |
| SCConfigException | - configuration error detected |
| - (void) removeCharStringValue: | (const char *) | charStringValue | |
| forKey: | (NSString *) | key | |
Removes from the receiving configuration the record with the specified char string value and key.
| charStringValue | - removed char string value |
| key | - removed key |
| SCConfigException | - configuration error detected |
| - (void) removeCharValue: | (char) | charValue | |
| forKey: | (NSString *) | key | |
Removes from the receiving configuration the record with the specified char value and key.
| charValue | - removed char value |
| key | - removed key |
| SCConfigException | - configuration error detected |
| - (void) removeConfigForKey: | (NSString *) | key |
Removes from the receiving configuration the subconfiguration for the specified key.
| key | - removed subconfiguration key |
| SCConfigException | - configuration error detected |
| - (void) removeConfiguration |
Removes all records from the configuration service lists.
| - (void) removeDateValue: | (NSDate *) | dateValue | |
| forKey: | (NSString *) | key | |
Removes from the receiving configuration the record with the specified date value and key.
| dateValue | - removed date value |
| key | - removed key |
| SCConfigException | - configuration error detected |
| - (void) removeDefaultValueForKey: | (NSString *) | key |
Removes the default value for the specified key from the default values list.
| key | - key for the default value to be deleted |
| - (void) removeDefaultValues |
Removes all records from the default values list.
| - (void) removeDoubleValue: | (SCDouble) | doubleValue | |
| forKey: | (NSString *) | key | |
Removes from the receiving configuration the record with the specified double value and key.
| doubleValue | - removed double value |
| key | - removed key |
| SCConfigException | - configuration error detected |
| - (void) removeFloatValue: | (SCFloat) | floatValue | |
| forKey: | (NSString *) | key | |
Removes from the receiving configuration the record with the specified float value and key.
| floatValue | - removed float value |
| key | - removed key |
| SCConfigException | - configuration error detected |
| - (void) removeIntValue: | (SCInteger) | intValue | |
| forKey: | (NSString *) | key | |
Removes from the receiving configuration the record with the specified signed integer value and key.
| intValue | - removed signed integer value |
| key | - removed key |
| SCConfigException | - configuration error detected |
| - (void) removeKeyNames |
Removes all records from the key names list.
| - (void) removeLongValue: | (SCLong) | longValue | |
| forKey: | (NSString *) | key | |
Removes from the receiving configuration the record with the specified signed long value and key.
| longValue | - removed signed long value |
| key | - removed key |
| SCConfigException | - configuration error detected |
| - (void) removeMandatoryKey: | (NSString *) | key |
Removes the specified key from the mandatory keys list.
| key | - removed key |
| - (void) removeMandatoryKeys |
Removes all records from the mandatory keys list.
| - (void) removeNameForKey: | (NSString *) | key |
Removes the specified key from the key names list.
| key | - removed key |
| - (void) removeNumberValue: | (NSNumber *) | numberValue | |
| forKey: | (NSString *) | key | |
Removes from the receiving configuration the record with the specified number value and key.
| numberValue | - removed number value |
| key | - removed key |
| SCConfigException | - configuration error detected |
| - (void) removeShortValue: | (SCShort) | shortValue | |
| forKey: | (NSString *) | key | |
Removes from the receiving configuration the record with the specified signed short value and key.
| shortValue | - removed signed short value |
| key | - removed key |
| SCConfigException | - configuration error detected |
| - (void) removeStringValue: | (NSString *) | stringValue | |
| forKey: | (NSString *) | key | |
Removes from the receiving configuration the record with the specified string value and key.
| stringValue | - removed string value |
| key | - removed key |
| SCConfigException | - configuration error detected |
| - (void) removeUnicharValue: | (unichar) | unicharValue | |
| forKey: | (NSString *) | key | |
Removes from the receiving configuration the record with the specified unichar value and key.
| unicharValue | - removed unichar value |
| key | - removed key |
| SCConfigException | - configuration error detected |
| - (void) removeUnsignedByteValue: | (SCUByte) | unsignedByteValue | |
| forKey: | (NSString *) | key | |
Removes from the receiving configuration the record with the specified unsigned byte value and key.
| unsignedByteValue | - removed unsigned byte value |
| key | - removed key |
| SCConfigException | - configuration error detected |
| - (void) removeUnsignedIntValue: | (SCUInteger) | unsignedIntValue | |
| forKey: | (NSString *) | key | |
Removes from the receiving configuration the record with the specified unsigned integer value and key.
| unsignedIntValue | - removed unsigned integer value |
| key | - removed key |
| SCConfigException | - configuration error detected |
| - (void) removeUnsignedLongValue: | (SCULong) | unsignedLongValue | |
| forKey: | (NSString *) | key | |
Removes from the receiving configuration the record with the specified unsigned long value and key.
| unsignedLongValue | - removed unsigned long value |
| key | - removed key |
| SCConfigException | - configuration error detected |
| - (void) removeUnsignedShortValue: | (SCUShort) | unsignedShortValue | |
| forKey: | (NSString *) | key | |
Removes from the receiving configuration the record with the specified unsigned short value and key.
| unsignedShortValue | - removed unsigned short value |
| key | - removed key |
| SCConfigException | - configuration error detected |
| - (void) removeValidDuplicateKey: | (NSString *) | key |
Removes the specified key from the duplicate allowing keys list.
| key | - removed key |
| - (void) removeValidKey: | (NSString *) | key |
Removes the specified key from the valid keys list.
| key | - removed key |
| - (void) removeValidKeys |
Removes all records from the valid keys list.
| - (void) removeValidType: | (SCConfigRecordType) | type | |
| forKey: | (NSString *) | key | |
Removes the specified valid type for a given key from the valid types list.
| type | - removed type |
| key | - key for the removed type |
| - (void) removeValidTypes |
Removes all records from the valid types list.
| - (void) removeValidTypesForKey: | (NSString *) | key |
Removes the all valid types for the specified key from the valid types list.
| key | - key for the removed valid types |
| - (void) removeValidValue: | (id) | value | |
| forKey: | (NSString *) | key | |
Removes the specified valid value for a given key from the valid values list.
| value | - removed value |
| key | - key for the removed value |
| - (void) removeValidValues |
Removes all records from the valid values list.
| - (void) removeValidValuesForKey: | (NSString *) | key |
Removes the all valid values for the specified key from the valid values list.
| key | - key for the removed valid values |
| - (void) removeValue: | (id) | value | |
| forKey: | (NSString *) | key | |
Removes from the receiving configuration the record with the specified value and key.
| value | - removed value |
| key | - removed key |
| SCConfigException | - configuration error detected |
| - (void) removeValuesForKey: | (NSString *) | key |
Removes all records with the specified key.
| key | - key to remove |
| SCConfigException | - configuration error detected |
| - (void) removeValuesForKeys: | (NSString *) | key | |
| , | ... | ||
Removes from the receiving configuration the values for the keys from the specified nil terminated list.
| key | - first removed key |
| ... | - other removed keys |
| SCConfigException | - configuration error detected |
| - (void) removeValuesForKeysFromArray: | (SCArray *) | array |
Removes from the receiving configuration the values for the keys from the specified array.
| array | - array with the removing keys |
| SCConfigException | - configuration error detected |
| - (void) resetConfiguration |
Remove all configuration records, clears the configuration service lists and sets the properties to the default values (excluding configuration name and delegate object).
| SCConfigException | - configuration error detected |
| - (void) setAutoCreate: | (BOOL) | autoCreate |
Sets the value of the flag which determines whether the receiving configuration allows the subsconfigurations automatic creation.
| autoCreate | - YES for autocreation allowing, NO for disabling automaric creation |
| - (void) setBoolValue: | (BOOL) | boolValue | |
| forKey: | (NSString *) | key | |
Sets the boolean value for the specified key. If the record with a given key is not present in the receiving configuration, the method creates it.
| boolValue | - new boolean value for the specified key |
| key | - key for the specified boolean value |
| SCConfigException | - configuration error detected |
| - (void) setBoolValue: | (BOOL) | value | |
| forKey: | (NSString *) | key | |
| withBoolValue: | (BOOL) | old | |
Sets the boolean value for the specified key and previous boolean value. If the record with a given key and value is not present in the receiving configuration, the method ignores it.
| value | - new boolean value for the specified key |
| key | - key for the specified boolean value |
| old | - previous boolean value of a given key |
| SCConfigException | - configuration error detected |
| - (void) setByteValue: | (SCByte) | byteValue | |
| forKey: | (NSString *) | key | |
Sets the signed byte value for the specified key. If the record with a given key is not present in the receiving configuration, the method creates it.
| byteValue | - new signed byte value for the specified key |
| key | - key for the specified signed byte value |
| SCConfigException | - configuration error detected |
Sets the signed byte value for the specified key and previous signed long value. If the record with a given key and value is not present in the receiving configuration, the method ignores it.
| value | - new signed byte value for the specified key |
| key | - key for the specified value |
| old | - previous signed long value of a given key |
| SCConfigException | - configuration error detected |
| - (void) setCaseInsensitive: | (BOOL) | caseInsensitive |
Sets the value of the flag which determines the receiving configuration ignores or not the case of the records keys.
| caseInsensitive | - YES for ignoring case, NO for case sensitive processing |
| - (void) setCharStringValue: | (const char *) | charStringValue | |
| forKey: | (NSString *) | key | |
Sets the character string value for the specified key. If the record with a given key is not present in the receiving configuration, the method creates it.
| charStringValue | - new character string value for the specified key |
| key | - key for the specified character string value |
| SCConfigException | - configuration error detected |
| - (void) setCharStringValue: | (const char *) | value | |
| forKey: | (NSString *) | key | |
| withCharStringValue: | (const char *) | old | |
Sets the char string value for the specified key and previous char string value. If the record with a given key and value is not present in the receiving configuration, the method ignores it.
| value | - new char string value for the specified key |
| key | - key for the specified value |
| old | - previous char string value of a given key |
| SCConfigException | - configuration error detected |
| - (void) setCharValue: | (char) | charValue | |
| forKey: | (NSString *) | key | |
Sets the char value for the specified key. If the record with a given key is not present in the receiving configuration, the method creates it.
| charValue | - new char value for the specified key |
| key | - key for the specified char value |
| SCConfigException | - configuration error detected |
| - (void) setCharValue: | (char) | value | |
| forKey: | (NSString *) | key | |
| withCharValue: | (char) | old | |
Sets the char value for the specified key and previous char value. If the record with a given key and value is not present in the receiving configuration, the method ignores it.
| value | - new char value for the specified key |
| key | - key for the specified value |
| old | - previous char value of a given key |
| SCConfigException | - configuration error detected |
| - (void) setCollection: | (id) | collection |
Erases the receiving configuration and copies all values from the specified existing collection.
| collection | - existing source collection |
| SCConfigException | - configuration error detected |
| - (void) setConfig: | (SCConfig *) | config |
Erases the receiving configuration and copies all values and settings from the specified existing configuration.
| config | - existing source configuration |
| SCConfigException | - configuration error detected |
| - (void) setConfig: | (SCConfig *) | config | |
| forKey: | (NSString *) | key | |
Sets the subconfiguration for a given key with the specified existing configuration. If the destination subconfiguration is not exists, the method creates it, otherwise replaces.
| config | - new subconfiguration |
| key | - subconfiguration key |
| SCConfigException | - configuration error detected |
| - (void) setDateValue: | (NSDate *) | dateValue | |
| forKey: | (NSString *) | key | |
Sets the date value for the specified key. If the record with a given key is not present in the receiving configuration, the method creates it.
| dateValue | - new date value for the specified key |
| key | - key for the specified date value |
| SCConfigException | - configuration error detected |
| - (void) setDateValue: | (NSDate *) | value | |
| forKey: | (NSString *) | key | |
| withDateValue: | (NSDate *) | old | |
Sets the date value for the specified key and previous date value. If the record with a given key and value is not present in the receiving configuration, the method ignores it.
| value | - new date value for the specified key |
| key | - key for the specified date value |
| old | - previous date value of a given key |
| SCConfigException | - configuration error detected |
| - (void) setDelegate: | (id<SCConfigDelegate>) | delegate |
Sets the receiving configuration delegate object.
| delegate | - delegate object or nil for remove previous delegate object |
| - (void) setDoubleValue: | (SCDouble) | doubleValue | |
| forKey: | (NSString *) | key | |
Sets the double value for the specified key. If the record with a given key is not present in the receiving configuration, the method creates it.
| doubleValue | - new double value for the specified key |
| key | - key for the specified double value |
| SCConfigException | - configuration error detected |
Sets the double value for the specified key and previous double value. If the record with a given key and value is not present in the receiving configuration, the method ignores it.
| value | - new double value for the specified key |
| key | - key for the specified value |
| old | - previous double value of a given key |
| SCConfigException | - configuration error detected |
| - (void) setFloatValue: | (SCFloat) | floatValue | |
| forKey: | (NSString *) | key | |
Sets the float value for the specified key. If the record with a given key is not present in the receiving configuration, the method creates it.
| floatValue | - new float value for the specified key |
| key | - key for the specified float value |
| SCConfigException | - configuration error detected |
Sets the float value for the specified key and previous float value. If the record with a given key and value is not present in the receiving configuration, the method ignores it.
| value | - new float value for the specified key |
| key | - key for the specified value |
| old | - previous float value of a given key |
| SCConfigException | - configuration error detected |
| - (void) setIgnoreErrors: | (BOOL) | ignoreErrors |
Sets the value of the flag which determines the receiving configuration ignores the detected errors or throws the exceptions.
| ignoreErrors | - YES for ignoring detected errors, NO for throws exceptions |
| - (void) setIntValue: | (SCInteger) | intValue | |
| forKey: | (NSString *) | key | |
Sets the signed integer value for the specified key. If the record with a given key is not present in the receiving configuration, the method creates it.
| intValue | - new signed integer value for the specified key |
| key | - key for the specified signed integer value |
| SCConfigException | - configuration error detected |
Sets the signed integer value for the specified key and previous signed long value. If the record with a given key and value is not present in the receiving configuration, the method ignores it.
| value | - new signed integer value for the specified key |
| key | - key for the specified value |
| old | - previous signed long value of a given key |
| SCConfigException | - configuration error detected |
| - (void) setLongValue: | (SCLong) | longValue | |
| forKey: | (NSString *) | key | |
Sets the signed long value for the specified key. If the record with a given key is not present in the receiving configuration, the method creates it.
| longValue | - new signed long value for the specified key |
| key | - key for the specified signed long value |
| SCConfigException | - configuration error detected |
Sets the signed long value for the specified key and previous signed long value. If the record with a given key and value is not present in the receiving configuration, the method ignores it.
| value | - new signed long value for the specified key |
| key | - key for the specified value |
| old | - previous signed long value of a given key |
| SCConfigException | - configuration error detected |
| - (void) setName: | (NSString *) | name |
Sets the receiving configuration name.
| - (void) setNumberValue: | (NSNumber *) | numberValue | |
| forKey: | (NSString *) | key | |
Sets the number value for the specified key. If the record with a given key is not present in the receiving configuration, the method creates it.
| numberValue | - new number value for the specified key |
| key | - key for the specified number value |
| SCConfigException | - configuration error detected |
| - (void) setNumberValue: | (NSNumber *) | value | |
| forKey: | (NSString *) | key | |
| withNumberValue: | (NSNumber *) | old | |
Sets the number value for the specified key and previous number value. If the record with a given key and value is not present in the receiving configuration, the method ignores it.
| value | - new number value for the specified key |
| key | - key for the specified number value |
| old | - previous number value of a given key |
| SCConfigException | - configuration error detected |
| - (void) setReadOnly: | (BOOL) | readonly |
Sets the value of the flag, which determines the possibility of changes in the receiving configuration.
| readonly | - YES for allowing changes, NO for disabling changes |
| - (void) setShortValue: | (SCShort) | shortValue | |
| forKey: | (NSString *) | key | |
Sets the signed short value for the specified key. If the record with a given key is not present in the receiving configuration, the method creates it.
| shortValue | - new signed short value for the specified key |
| key | - key for the specified signed short value |
| SCConfigException | - configuration error detected |
Sets the signed short value for the specified key and previous signed long value. If the record with a given key and value is not present in the receiving configuration, the method ignores it.
| value | - new signed short value for the specified key |
| key | - key for the specified value |
| old | - previous signed long value of a given key |
| SCConfigException | - configuration error detected |
| - (void) setStringValue: | (NSString *) | stringValue | |
| forKey: | (NSString *) | key | |
Sets the string value for the specified key. If the record with a given key is not present in the receiving configuration, the method creates it.
| stringValue | - new string value for the specified key |
| key | - key for the specified string value |
| SCConfigException | - configuration error detected |
| - (void) setStringValue: | (NSString *) | value | |
| forKey: | (NSString *) | key | |
| withStringValue: | (NSString *) | old | |
Sets the string value for the specified key and previous string value. If the record with a given key and value is not present in the receiving configuration, the method ignores it.
| value | - new string value for the specified key |
| key | - key for the specified string value |
| old | - previous string value of a given key |
| SCConfigException | - configuration error detected |
| - (void) setText: | (SCStrings *) | text |
Erases the receiving configuratopm and copies all values from the specified existing strings list.
| text | - existing source strings list |
| SCConfigException | - configuration error detected |
| - (void) setUnicharValue: | (unichar) | unicharValue | |
| forKey: | (NSString *) | key | |
Sets the unichar value for the specified key. If the record with a given key is not present in the receiving configuration, the method creates it.
| unicharValue | - new unichar value for the specified key |
| key | - key for the specified unichar value |
| SCConfigException | - configuration error detected |
| - (void) setUnicharValue: | (unichar) | value | |
| forKey: | (NSString *) | key | |
| withUnicharValue: | (unichar) | old | |
Sets the unichar value for the specified key and previous unichar value. If the record with a given key and value is not present in the receiving configuration, the method ignores it.
| value | - new unichar value for the specified key |
| key | - key for the specified value |
| old | - previous unichar value of a given key |
| SCConfigException | - configuration error detected |
| - (void) setUnique: | (BOOL) | unique |
Sets the value of the flag which determines the configuration unique mode - allowed or not allowed adding into the receiving configuration records with the duplicated records.
| unique | - YES if the duplicated records do not allowed (excepted the records with the keys from the allowed duplicated keys list), NO if the duplicated records are allowed |
| - (void) setUnsignedByteValue: | (SCUByte) | unsignedByteValue | |
| forKey: | (NSString *) | key | |
Sets the unsigned byte value for the specified key. If the record with a given key is not present in the receiving configuration, the method creates it.
| unsignedByteValue | - new unsigned byte value for the specified key |
| key | - key for the specified unsigned byte value |
| SCConfigException | - configuration error detected |
Sets the unsigned byte value for the specified key and previous signed long value. If the record with a given key and value is not present in the receiving configuration, the method ignores it.
| value | - new unsigned byte value for the specified key |
| key | - key for the specified value |
| old | - previous signed long value of a given key |
| SCConfigException | - configuration error detected |
| - (void) setUnsignedIntValue: | (SCUInteger) | unsignedIntValue | |
| forKey: | (NSString *) | key | |
Sets the unsigned integer value for the specified key. If the record with a given key is not present in the receiving configuration, the method creates it.
| unsignedIntValue | - new unsigned integer value for the specified key |
| key | - key for the specified unsigned integer value |
| SCConfigException | - configuration error detected |
| - (void) setUnsignedIntValue: | (SCUInteger) | value | |
| forKey: | (NSString *) | key | |
| withLongValue: | (SCLong) | old | |
Sets the unsigned integer value for the specified key and previous signed long value. If the record with a given key and value is not present in the receiving configuration, the method ignores it.
| value | - new unsigned integer value for the specified key |
| key | - key for the specified value |
| old | - previous signed long value of a given key |
| SCConfigException | - configuration error detected |
| - (void) setUnsignedLongValue: | (SCULong) | unsignedLongValue | |
| forKey: | (NSString *) | key | |
Sets the unsigned long value for the specified key. If the record with a given key is not present in the receiving configuration, the method creates it.
| unsignedLongValue | - new unsigned long value for the specified key |
| key | - key for the specified unsigned long value |
| SCConfigException | - configuration error detected |
Sets the unsigned long value for the specified key and previous signed long value. If the record with a given key and value is not present in the receiving configuration, the method ignores it.
| value | - new unsigned long value for the specified key |
| key | - key for the specified value |
| old | - previous signed long value of a given key |
| SCConfigException | - configuration error detected |
| - (void) setUnsignedShortValue: | (SCUShort) | unsignedShortValue | |
| forKey: | (NSString *) | key | |
Sets the unsigned short value for the specified key. If the record with a given key is not present in the receiving configuration, the method creates it.
| unsignedShortValue | - new unsigned short value for the specified key |
| key | - key for the specified unsigned short value |
| SCConfigException | - configuration error detected |
| - (void) setUnsignedShortValue: | (SCUShort) | value | |
| forKey: | (NSString *) | key | |
| withLongValue: | (SCLong) | old | |
Sets the unsigned short value for the specified key and previous signed long value. If the record with a given key and value is not present in the receiving configuration, the method ignores it.
| value | - new unsigned short value for the specified key |
| key | - key for the specified value |
| old | - previous signed long value of a given key |
| SCConfigException | - configuration error detected |
| - (void) setValue: | (id) | value | |
| forKey: | (NSString *) | key | |
Sets the value for the specified key. If the record with a given key is not present in the receiving configuration, the method creates it.
| value | - new value for the specified key |
| key | - key for the specified value |
| SCConfigException | - configuration error detected |
| - (void) setValue: | (id) | value | |
| forKey: | (NSString *) | key | |
| withValue: | (id) | oldValue | |
Sets the value for the specified key and previous value. If the record with a given key and value is not present in the receiving configuration, the method ignores it.
| value | - new value for the specified key |
| key | - key for the specified value |
| oldValue | - previous value of a given key |
| SCConfigException | - configuration error detected |
| - (SCShort) shortValueForKey: | (NSString *) | key |
Returns the signed short value assodicated with a given key.
| key | - the key for which to return the corresponding value |
| SCConfigException | - configuration error detected |
| - (SCConfigStatus) status |
Returns the receiving configuration status.
| - (NSString *) stringValueForKey: | (NSString *) | key |
Returns the string value assodicated with a given key.
| key | - the key for which to return the corresponding value |
| SCConfigException | - configuration error detected |
| - (SCULong) stringValuesCount |
Returns a count of the string values in the receiving configuration.
| - (SCStrings *) text |
Returns the text with the receiving configuration records with using the equals sign as a key/value delimiter.
| - (SCStrings *) textWithSpace: | (BOOL) | space |
Returns the text with the receiving configuration records.
| space | - YES for using space as a key/value delimiter, NO for using the equals sign |
| - (SCConfigRecordType) typeForKey: | (NSString *) | key |
Returns the type of the record with the specified key.
| key | - the key for which to return the corresponding type |
| SCConfigException | - configuration error detected |
| - (NSString *) typeNameForKey: | (NSString *) | key |
Returns the type name of the record with the specified key.
| key | - the key for which to return the corresponding type name |
| SCConfigException | - configuration error detected |
| - (unichar) unicharValueForKey: | (NSString *) | key |
Returns the unichar value assodicated with a given key.
| key | - the key for which to return the corresponding value |
| SCConfigException | - configuration error detected |
| - (SCUByte) unsignedByteValueForKey: | (NSString *) | key |
Returns the unsigned byte value assodicated with a given key.
| key | - the key for which to return the corresponding value |
| SCConfigException | - configuration error detected |
| - (SCUInteger) unsignedIntValueForKey: | (NSString *) | key |
Returns the unsigned integer value assodicated with a given key.
| key | - the key for which to return the corresponding value |
| SCConfigException | - configuration error detected |
| - (SCULong) unsignedLongValueForKey: | (NSString *) | key |
Returns the unsigned long value assodicated with a given key.
| key | - the key for which to return the corresponding value |
| SCConfigException | - configuration error detected |
| - (SCUShort) unsignedShortValueForKey: | (NSString *) | key |
Returns the unsigned byte value assodicated with a given key.
| key | - the key for which to return the corresponding value |
| SCConfigException | - configuration error detected |
| - (SCArray *) validKeys |
Returns the configuration valid keys list.
| - (SCArray *) validTypes |
Returns the valid types list for the receiving local configuration.
| - (SCArray *) validTypesForKey: | (NSString *) | key |
Returns the valid types list for the specified key.
| key | - the key for which to return the valid types list |
| - (SCArray *) validValues |
Returns the valid values list for the receiving local configuration.
| - (SCArray *) validValuesForKey: | (NSString *) | key |
Returns the valid values list for the specified key.
| key | - the key for which to return the valid values list. |
| - (id) valueForKey: | (NSString *) | key |
Returns the value associated with a given key.
| key | - the key for which to return the corresponding value |
| SCConfigException | - configuration error detected |
| - (SCArray *) valuesForKey: | (NSString *) | key |
Returns the array with the values for a given key.
| key | - the key for which to return the corresponding values |
| - (SCArray *) valuesForKeys: | (NSString *) | key | |
| , | ... | ||
Returns the array with the values for a keys from the specified nil terminated list.
| key | - the first key for which to return the corresponding values |
| ... | - the other keys for which to return the corresponding values |
Returns the array with the values for a keys from the specified array.
| keys | - the array with the keys for which to return the corresponding values |
1.7.3