ActiveRecord/Castle.ActiveRecord/Attributes/WithAccessAttribute.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.ActiveRecord
  16 {
  17         using System;
  18
  19         /// <summary>
  20         /// Base class that allows specifying an access strategy to get/set the value for an object' property.
  21         /// </summary>
  22         [AttributeUsage(AttributeTargets.Property, AllowMultiple=false), Serializable]
  23         public abstract class WithAccessAttribute : Attribute
  24         {
  25                 private PropertyAccess access = PropertyAccess.Property;
  26                 private string customAccess = null;
  27
  28                 /// <summary>
  29                 /// Gets or sets the access strategy for this property
  30                 /// </summary>
  31                 public PropertyAccess Access
  32                 {
  33                         get { return access; }
  34                         set { access = value; }
  35                 }
  36
  37                 /// <summary>
  38                 /// Gets or sets the custom access strategy
  39                 /// </summary>
  40                 /// <value>The custom access.</value>
  41                 public string CustomAccess
  42                 {
  43                         get { return customAccess;}
  44                         set { customAccess=value;}
  45                 }
  46
  47                 /// <summary>
  48                 /// Gets the access strategy string for NHibernate's mapping.
  49                 /// </summary>
  50                 /// <value>The access string.</value>
  51                 public string AccessString
  52                 {
  53                         get
  54                         {
  55                                 if (CustomAccess != null)
  56                                 {
  57                                         return CustomAccess;
  58                                 }
  59
  60                                 return PropertyAccessHelper.ToString(Access);
  61                         }
  62                 }
  63         }
  64 }