Components/DictionaryAdapter/Castle.Components.DictionaryAdapter/IDictionaryAdapterFactory.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
  16 namespace Castle.Components.DictionaryAdapter
  17 {
  18         using System;
  19         using System.Collections;
  20         using System.Collections.Specialized;
  21
  22         /// <summary>
  23         /// Defines the contract for building typed dictionary adapters.
  24         /// </summary>
  25         public interface IDictionaryAdapterFactory
  26         {
  27                 /// <summary>
  28                 /// Gets a typed adapter bound to the <see cref="IDictionary"/>.
  29                 /// </summary>
  30                 /// <typeparam name="T">The typed interface.</typeparam>
  31                 /// <param name="dictionary">The underlying source of properties.</param>
  32                 /// <returns>An implementation of the typed interface bound to the dictionary.</returns>
  33                 /// <remarks>
  34                 /// The type represented by T must be an interface with properties.
  35                 /// </remarks>
  36                 T GetAdapter<T>(IDictionary dictionary);
  37
  38                 /// <summary>
  39                 /// Gets a typed adapter bound to the <see cref="IDictionary"/>.
  40                 /// </summary>
  41                 /// <param name="type">The typed interface.</param>
  42                 /// <param name="dictionary">The underlying source of properties.</param>
  43                 /// <returns>An implementation of the typed interface bound to the dictionary.</returns>
  44                 /// <remarks>
  45                 /// The type represented by T must be an interface with properties.
  46                 /// </remarks>
  47                 object GetAdapter(Type type, IDictionary dictionary);
  48
  49                 /// <summary>
  50                 /// Gets a typed adapter bound to the <see cref="IDictionary"/>.
  51                 /// </summary>
  52                 /// <param name="type">The typed interface.</param>
  53                 /// <param name="dictionary">The underlying source of properties.</param>
  54                 /// <param name="descriptor">The property descriptor.</param>
  55                 /// <returns>An implementation of the typed interface bound to the dictionary.</returns>
  56                 /// <remarks>
  57                 /// The type represented by T must be an interface with properties.
  58                 /// </remarks>
  59                 object GetAdapter(Type type, IDictionary dictionary, PropertyDescriptor descriptor);
  60
  61                 /// <summary>
  62                 /// Gets a typed adapter bound to the <see cref="NameValueCollection"/>.
  63                 /// </summary>
  64                 /// <typeparam name="T">The typed interface.</typeparam>
  65                 /// <param name="nameValues">The underlying source of properties.</param>
  66                 /// <returns>An implementation of the typed interface bound to the namedValues.</returns>
  67                 /// <remarks>
  68                 /// The type represented by T must be an interface with properties.
  69                 /// </remarks>
  70                 T GetAdapter<T>(NameValueCollection nameValues);
  71
  72                 /// <summary>
  73                 /// Gets a typed adapter bound to the <see cref="NameValueCollection"/>.
  74                 /// </summary>
  75                 /// <param name="type">The typed interface.</param>
  76                 /// <param name="nameValues">The underlying source of properties.</param>
  77                 /// <returns>An implementation of the typed interface bound to the namedValues.</returns>
  78                 /// <remarks>
  79                 /// The type represented by T must be an interface with properties.
  80                 /// </remarks>
  81                 object GetAdapter(Type type, NameValueCollection nameValues);
  82         }
  83 }