MonoRail/Castle.MonoRail.Framework/Attributes/SkipFilterAttribute.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.MonoRail.Framework
  16 {
  17         using System;
  18
  19         /// <summary>
  20         /// Declares that for the specific method (action)
  21         /// no filter should be applied -- or an specific filter should be
  22         /// skipped.
  23         /// </summary>
  24         [AttributeUsage(AttributeTargets.Method, AllowMultiple=true), Serializable]
  25         public class SkipFilterAttribute : Attribute
  26         {
  27                 private Type filterType;
  28
  29                 /// <summary>
  30                 /// Constructs a SkipFilterAttribute which skips all filters.
  31                 /// </summary>
  32                 public SkipFilterAttribute()
  33                 {
  34                 }
  35
  36                 /// <summary>
  37                 /// Constructs a SkipFilterAttribute associating
  38                 /// the filter type that should be skipped.
  39                 /// </summary>
  40                 /// <param name="filterType">The filter type to be skipped</param>
  41                 public SkipFilterAttribute(Type filterType)
  42                 {
  43                         this.filterType = filterType;
  44                 }
  45
  46                 /// <summary>
  47                 /// Gets the type of the filter.
  48                 /// </summary>
  49                 /// <value>The type of the filter.</value>
  50                 public Type FilterType
  51                 {
  52                         get { return filterType; }
  53                 }
  54
  55                 /// <summary>
  56                 /// Gets a value indicating whether [blanket skip].
  57                 /// </summary>
  58                 /// <value><c>true</c> if [blanket skip]; otherwise, <c>false</c>.</value>
  59                 internal bool BlanketSkip
  60                 {
  61                         get { return filterType == null; }
  62                 }
  63         }
  64 }