Components/Binder/Castle.Components.Binder/IBinderTranslator.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.Components.Binder
  16 {
  17         using System;
  18
  19         /// <summary>
  20         /// Provides a way to properties on the binder target
  21         /// be bound to a different key in the data source.
  22         /// </summary>
  23         public interface IBinderTranslator
  24         {
  25                 /// <summary>
  26                 /// Should return the key that gathers the value
  27                 /// to fill the property.
  28                 /// </summary>
  29                 /// <param name="instanceType">
  30                 /// The type which is the target of the binder
  31                 /// </param>
  32                 /// <param name="paramName">
  33                 /// The property name in  the target type
  34                 /// </param>
  35                 /// <returns>
  36                 /// A name of the source data that should be used to populate the property
  37                 /// </returns>
  38                 String Translate(Type instanceType, String paramName);
  39         }
  40 }