MonoRail/Castle.MonoRail.Framework/Providers/IHelperDescriptorProvider.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 Castle.MonoRail.Framework.Descriptors;
  19
  20         /// <summary>
  21         /// Defines the contract to an implementation
  22         /// that wish to create <see cref="HelperDescriptor"/>.
  23         /// </summary>
  24         /// <remarks>
  25         /// The default implementation creates the descriptors
  26         /// based on <see cref="HelperAttribute"/> associated
  27         /// with the controller
  28         /// </remarks>
  29         public interface IHelperDescriptorProvider : IProvider
  30         {
  31                 /// <summary>
  32                 /// Implementors should collect the helper information
  33                 /// and return descriptors instances, or an empty array if none
  34                 /// was found.
  35                 /// </summary>
  36                 /// <param name="controllerType">The controller type</param>
  37                 /// <returns>An array of <see cref="HelperDescriptor"/></returns>
  38                 HelperDescriptor[] CollectHelpers(Type controllerType);
  39         }
  40 }