Channels ▼

Arnon Rotem-Gal-Oz

Dr. Dobb's Bloggers

Config Reader Utility

November 04, 2008

Reshef Mann, one of the members of our devdiv released a nifty little utility for reading configuration files into easy to work-with type-safe interface.
Instead of trying to explain it - Here is the example from his Getting Started :

When you have .config file:

<span class="pun"><?</span><span class="pln">xml version</span><span class="pun">=</span><span class="str">"1.0"</span><span class="pln"> encoding</span><span class="pun">=</span><span class="str">"utf-8"</span><span class="pln"> </span><span class="pun">?></span><span class="pln"><br /></span><span class="pun"><</span><span class="tag">configuration</span><span class="pun">></span><span class="pln"><br />  </span><span class="pun"><</span><span class="tag">appSettings</span><span class="pun">></span><span class="pln"><br />    </span><span class="pun"><</span><span class="tag">add</span><span class="pln"> </span><span class="atn">key</span><span class="pun">=</span><span class="atv">"MailNotificationSettings.SmtpServerAddress"</span><span class="pln"> </span><span class="atn">value</span><span class="pun">=</span><span class="atv">"http://localhost"</span><span class="pun">/></span><span class="pln"><br />    </span><span class="pun"><</span><span class="tag">add</span><span class="pln"> </span><span class="atn">key</span><span class="pun">=</span><span class="atv">"MailNotificationSettings.Username"</span><span class="pln"> </span><span class="atn">value</span><span class="pun">=</span><span class="atv">"user123"</span><span class="pun">/></span><span class="pln"><br />    </span><span class="pun"><</span><span class="tag">add</span><span class="pln"> </span><span class="atn">key</span><span class="pun">=</span><span class="atv">"MailNotificationSettings.Password"</span><span class="pln"> </span><span class="atn">value</span><span class="pun">=</span><span class="atv">"passwd123"</span><span class="pun">/></span><span class="pln"><br />  </span><span class="pun"></</span><span class="tag">appSettings</span><span class="pun">></span><span class="pln"><br /></span><span class="pun"></</span><span class="tag">configuration</span><span class="pun">></span>

Define the following interface:

<span class="kwd">public</span><span class="pln"> </span><span class="kwd">interface</span><span class="pln"> </span><span class="typ">IMailNotificationSettings</span><span class="pln"><br /></span><span class="pun">{</span><span class="pln"><br />    </span><span class="typ">Uri</span><span class="pln"> </span><span class="typ">SmtpServerAddress</span><span class="pln"> </span><span class="pun">{</span><span class="pln"> </span><span class="kwd">get</span><span class="pun">;</span><span class="pln"> </span><span class="pun">}</span><span class="pln"><br />    </span><span class="kwd">string</span><span class="pln"> </span><span class="typ">Username</span><span class="pln"> </span><span class="pun">{</span><span class="pln"> </span><span class="kwd">get</span><span class="pun">;</span><span class="pln"> </span><span class="pun">}</span><span class="pln"><br />    </span><span class="kwd">string</span><span class="pln"> </span><span class="typ">Password</span><span class="pln"> </span><span class="pun">{</span><span class="pln"> </span><span class="kwd">get</span><span class="pun">;</span><span class="pln"> </span><span class="pun">}</span><span class="pln"><br /></span><span class="pun">}</span>

And from your program use this code:

<span class="kwd">public</span><span class="pln"> </span><span class="kwd">static</span><span class="pln"> </span><span class="kwd">void</span><span class="pln"> </span><span class="typ">Main</span><span class="pun">()</span><span class="pln"><br /></span><span class="pun">{</span><span class="pln"><br />        </span><span class="typ">ConfigurationReader</span><span class="pln"> configReader </span><span class="pun">=</span><span class="pln"> </span><span class="kwd">new</span><span class="pln"> </span><span class="typ">ConfigurationReader</span><span class="pun">().</span><span class="typ">SetupConfigOf</span><span class="pun"><</span><span class="typ">IMailNotificationSettings</span><span class="pun">>();</span><span class="pln"><br />        </span><span class="typ">IMailNotificationSettings</span><span class="pln"> mailNotificationSettings </span><span class="pun">=</span><span class="pln"> configReader</span><span class="pun">.</span><span class="typ">ConfigBrowser</span><span class="pun">.</span><span class="typ">Get</span><span class="pun"><</span><span class="typ">IMailNotificationSettings</span><span class="pun">>();</span><span class="pln"><br />        <br />        </span><span class="kwd">var</span><span class="pln"> mailNotificationService </span><span class="pun">=</span><span class="pln"> </span><span class="kwd">new</span><span class="pln"> </span><span class="typ">MailNotificationService</span><span class="pun">(</span><span class="pln">mailNotificationSettings</span><span class="pun">);</span><span class="pln"><br />        <br />        </span><span class="com">//</span><span class="pln"><br />        </span><span class="com">//      Do the work..</span><span class="pln"><br />        </span><span class="com">//</span><span class="pln"><br /></span><span class="pun">}</span><span class="pln"><br /></span>


The project is open sourced under the Apache 2.0 license- so feel free to use it

Related Reading


More Insights






Currently we allow the following HTML tags in comments:

Single tags

These tags can be used alone and don't need an ending tag.

<br> Defines a single line break

<hr> Defines a horizontal line

Matching tags

These require an ending tag - e.g. <i>italic text</i>

<a> Defines an anchor

<b> Defines bold text

<big> Defines big text

<blockquote> Defines a long quotation

<caption> Defines a table caption

<cite> Defines a citation

<code> Defines computer code text

<em> Defines emphasized text

<fieldset> Defines a border around elements in a form

<h1> This is heading 1

<h2> This is heading 2

<h3> This is heading 3

<h4> This is heading 4

<h5> This is heading 5

<h6> This is heading 6

<i> Defines italic text

<p> Defines a paragraph

<pre> Defines preformatted text

<q> Defines a short quotation

<samp> Defines sample computer code text

<small> Defines small text

<span> Defines a section in a document

<s> Defines strikethrough text

<strike> Defines strikethrough text

<strong> Defines strong text

<sub> Defines subscripted text

<sup> Defines superscripted text

<u> Defines underlined text

Dr. Dobb's encourages readers to engage in spirited, healthy debate, including taking us to task. However, Dr. Dobb's moderates all comments posted to our site, and reserves the right to modify or remove any content that it determines to be derogatory, offensive, inflammatory, vulgar, irrelevant/off-topic, racist or obvious marketing or spam. Dr. Dobb's further reserves the right to disable the profile of any commenter participating in said activities.

 
Disqus Tips To upload an avatar photo, first complete your Disqus profile. | View the list of supported HTML tags you can use to style comments. | Please read our commenting policy.
 


Video