Components/DictionaryAdapter/Castle.Components.DictionaryAdapter/Attributes/DictionaryAdapterKeyPrefixAttribute.cs

   1 // Copyright 2004-2007 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.DictionaryAdapter
  16 {
  17         using System;
  18         using System.Collections;
  19
  20         /// <summary>
  21         /// Assigns a prefix to the keyed properties of an interface.
  22         /// </summary>
  23         [AttributeUsage(AttributeTargets.Interface, AllowMultiple = false, Inherited = true)]
  24         public class DictionaryAdapterKeyPrefixAttribute : Attribute, IDictionaryKeyBuilder
  25         {
  26                 private String keyPrefix;
  27
  28                 /// <summary>
  29                 /// Initializes a default instance of the <see cref="DictionaryAdapterKeyPrefixAttribute"/> class.
  30                 /// </summary>
  31                 public DictionaryAdapterKeyPrefixAttribute()
  32                 {
  33                 }
  34
  35                 /// <summary>
  36                 /// Initializes a new instance of the <see cref="DictionaryAdapterKeyPrefixAttribute"/> class.
  37                 /// </summary>
  38                 /// <param name="keyPrefix">The prefix for the keyed properties of the interface.</param>
  39                 public DictionaryAdapterKeyPrefixAttribute(String keyPrefix)
  40                 {
  41                         this.keyPrefix = keyPrefix;
  42                 }
  43
  44                 /// <summary>
  45                 /// Gets the prefix key added to the properties of the interface.
  46                 /// </summary>
  47                 public String KeyPrefix
  48                 {
  49                         get { return keyPrefix; }
  50                         set { keyPrefix = value; }
  51                 }
  52
  53                 String IDictionaryKeyBuilder.GetKey(IDictionary dictionary, String key,
  54                                                    PropertyDescriptor property)
  55                 {
  56                         return keyPrefix + key;
  57                 }
  58         }
  59 }