InversionOfControl/Castle.Windsor/Configuration/IConfigurationInterpreter.cs

   1 // Copyright 2004-2008 Castle Project - http://www.castleproject.org/
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 namespace Castle.Windsor.Configuration
  16 {
  17         using Castle.MicroKernel;
  18
  19         using Castle.Core.Resource;
  20
  21         /// <summary>
  22         /// Interpreter of a specific language to describe
  23         /// configuration nodes in a hierachical manner.
  24         /// </summary>
  25         public interface IConfigurationInterpreter
  26         {
  27                 /// <summary>
  28                 /// Gets or sets the name of the environment.
  29                 /// </summary>
  30                 /// <value>The name of the environment.</value>
  31                 string EnvironmentName { get; set; }
  32
  33                 /// <summary>
  34                 /// Exposes the reference to <see cref="IResource"/>
  35                 /// which the interpreter is likely to hold
  36                 /// </summary>
  37                 IResource Source { get; }
  38
  39                 /// <summary>
  40                 /// Should obtain the contents from the resource,
  41                 /// interpret it and populate the <see cref="IConfigurationStore"/>
  42                 /// accordingly.
  43                 /// </summary>
  44                 /// <param name="resource"></param>
  45                 /// <param name="store"></param>
  46                 void ProcessResource(IResource resource, IConfigurationStore store);
  47         }
  48 }