MonoRail/Castle.MonoRail.Framework/Providers/IRescueDescriptorProvider.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.Providers
  16 {
  17         using System;
  18         using System.Reflection;
  19         using Castle.MonoRail.Framework.Descriptors;
  20
  21         /// <summary>
  22         /// Defines the contract to an implementation
  23         /// that wish to create <see cref="RescueDescriptor"/>.
  24         /// </summary>
  25         /// <remarks>
  26         /// The default implementation creates the descriptors
  27         /// based on <see cref="RescueAttribute"/> associated
  28         /// with the controller
  29         /// </remarks>
  30         public interface IRescueDescriptorProvider : IProvider
  31         {
  32                 /// <summary>
  33                 /// Implementors should collect the rescue information
  34                 /// and return descriptors instances, or an empty array if none
  35                 /// was found.
  36                 /// </summary>
  37                 /// <param name="memberInfo">The controller type</param>
  38                 /// <returns>An array of <see cref="RescueDescriptor"/></returns>
  39                 RescueDescriptor[] CollectRescues(Type memberInfo);
  40
  41                 /// <summary>
  42                 /// Implementors should collect the rescue information
  43                 /// and return descriptors instances, or an empty array if none
  44                 /// was found.
  45                 /// </summary>
  46                 /// <param name="memberInfo">The action (MethodInfo)</param>
  47                 /// <returns>An array of <see cref="RescueDescriptor"/></returns>
  48                 RescueDescriptor[] CollectRescues(MethodInfo memberInfo);
  49         }
  50 }