Samond Classes Library 1.1.6-RELEASE build 132: SCConfigDelegate.h Source File

Samond Classes Library 1.1.6-RELEASE build 132
00001 //
00002 //  SCConfigDelegate.h
00003 //  sclmac
00004 //
00005 //  Created by Viacheslav Smolensky on 05.06.14.
00006 //  Copyright (c) 2007 - 2014 by Samond Development Corporation. All rights reserved.
00007 //
00008 
00016 #import <Foundation/Foundation.h>
00017 #import <scl/SCConfigRecord.h>
00018 #import <scl/SCStrings.h>
00019 
00020 @class SCConfig;
00021 @class SCConfigFile;
00022 
00029 @protocol SCConfigDelegate
00030 
00031 @optional
00032 
00033 #pragma mark -
00034 #pragma Configuration Validation Methods
00035 
00043 - (BOOL)config:(SCConfig *)config isValidConfigForKey:(NSString *)key;
00044 
00052 - (BOOL)config:(SCConfig *)config isValidKey:(NSString *)key;
00053 
00061 - (BOOL)config:(SCConfig *)config isValidType:(SCConfigRecordType)type forKey:(NSString *)key;
00062 
00070 - (BOOL)config:(SCConfig *)config isValidValue:(id)value forKey:(NSString *)key;
00071 
00079 - (BOOL)config:(SCConfig *)config isAllowedDuplicateValueForKey:(NSString *)key;
00080 
00087 - (NSString *)config:(SCConfig *)config keyNameForKey:(NSString *)key;
00088 
00089 #pragma mark -
00090 #pragma mark Configuration Prior Events Methods
00091 
00093 - (void)config:(SCConfig *)config willCreateConfigForKey:(NSString *)key;
00094 - (void)config:(SCConfig *)config willAddValue:(id)value withType:(SCConfigRecordType)type
00095                 forKey:(NSString *)key;
00096 - (void)config:(SCConfig *)config willAddValuesFromConfig:(SCConfig *)source;
00097 - (void)config:(SCConfig *)config willAddValuesFromText:(SCStrings *)text;
00098 - (void)config:(SCConfig *)config willSetValue:(id)value withType:(SCConfigRecordType)type
00099                 forKey:(NSString *)key;
00100 - (void)config:(SCConfig *)config willRemoveValuesForKey:(NSString *)key;
00101 - (void)config:(SCConfig *)config willRemoveValue:(id)value forKey:(NSString *)key;
00102 - (void)config:(SCConfig *)config willRemoveConfigForKey:(NSString *)key;
00103 - (void)config:(SCConfig *)config willAddConfig:(SCConfig *)sub forKey:(NSString *)key;
00104 - (void)config:(SCConfig *)config willSetConfig:(SCConfig *)sub forKey:(NSString *)key;
00105 - (void)willRemoveAllRecordsFromConfig:(SCConfig *)config;
00106 - (void)willAddDefaultValuesToConfig:(SCConfig *)config;
00107 - (void)willCheckMandatoryKeysForConfig:(SCConfig *)config;
00108 
00109 #pragma mark -
00110 #pragma mark Configuration File Prior Events Methods
00111 
00113 - (void)configFile:(SCConfigFile *)configFile willReadFromText:(SCStrings *)text;
00114 - (void)configFile:(SCConfigFile *)configFile willReadFromStream:(SCStream *)stream;
00115 - (void)configFile:(SCConfigFile *)configFile willReadWithPath:(NSString *)path;
00116 - (void)configFile:(SCConfigFile *)configFile willAppendToText:(SCStrings *)text;
00117 - (void)configFile:(SCConfigFile *)configFile willAppendToPath:(NSString *)path;
00118 - (void)configFile:(SCConfigFile *)configFile willWriteToText:(SCStrings *)text;
00119 - (void)configFile:(SCConfigFile *)configFile willWriteToStream:(SCStream *)stream;
00120 - (void)configFile:(SCConfigFile *)configFile willWriteToPath:(NSString *)path;
00121 
00122 #pragma mark -
00123 #pragma mark Configuration Completed Events Methods
00124 
00126 - (void)config:(SCConfig *)config didFinishCreatingConfigForKey:(NSString *)key;
00127 - (void)config:(SCConfig *)config didFinishAddingValue:(id)value withType:(SCConfigRecordType)type
00128                 forKey:(NSString *)key;
00129 - (void)config:(SCConfig *)config didFinishAddingValuesFromConfig:(SCConfig *)source;
00130 - (void)config:(SCConfig *)config didFinishAddingValuesFromText:(SCStrings *)text;
00131 - (void)config:(SCConfig *)config didFinishSettingValue:(id)value withType:(SCConfigRecordType)type
00132                 forKey:(NSString *)key;
00133 - (void)config:(SCConfig *)config didFinishRemovingValuesForKey:(NSString *)key;
00134 - (void)config:(SCConfig *)config didFinishRemovingValue:(id)value forKey:(NSString *)key;
00135 - (void)config:(SCConfig *)config didFinishRemovingConfigForKey:(NSString *)key;
00136 - (void)config:(SCConfig *)config didFinishAddingConfig:(SCConfig *)sub forKey:(NSString *)key;
00137 - (void)config:(SCConfig *)config didFinishSettingConfig:(SCConfig *)sub forKey:(NSString *)key;
00138 - (void)didFinishRemovingAllRecordsFromConfig:(SCConfig *)config;
00139 - (void)didFinishAddingDefaultValuesToConfig:(SCConfig *)config;
00140 - (void)didFinishCheckingMandatoryKeysForConfig:(SCConfig *)config;
00141 
00142 #pragma mark -
00143 #pragma mark Configuration File Completed Events Methods
00144 
00146 - (void)configFile:(SCConfigFile *)configFile didFinishReadingFromText:(SCStrings *)text;
00147 - (void)configFile:(SCConfigFile *)configFile didFinishReadingFromStream:(SCStream *)stream;
00148 - (void)configFile:(SCConfigFile *)configFile didFinishReadingWithPath:(NSString *)path;
00149 - (void)configFile:(SCConfigFile *)configFile didFinishAppendingToText:(SCStrings *)text;
00150 - (void)configFile:(SCConfigFile *)configFile didFinishAppendingToPath:(NSString *)path;
00151 - (void)configFile:(SCConfigFile *)configFile didFinishWritingToText:(SCStrings *)text;
00152 - (void)configFile:(SCConfigFile *)configFile didFinishWritingToStream:(SCStream *)stream;
00153 - (void)configFile:(SCConfigFile *)configFile didFinishWritingToPath:(NSString *)path;
00154 
00155 @end