MonoRail/Castle.MonoRail.Framework/Descriptors/HelperDescriptor.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.Descriptors
  16 {
  17         using System;
  18
  19         /// <summary>
  20         /// Represents the information about a Helper class
  21         /// associated with a <see cref="IController"/>
  22         /// </summary>
  23         public class HelperDescriptor
  24         {
  25                 private readonly String name;
  26                 private readonly Type helperType;
  27
  28                 /// <summary>
  29                 /// Initializes a new instance of the <see cref="HelperDescriptor"/> class.
  30                 /// </summary>
  31                 /// <param name="helperType">Type of the helper.</param>
  32                 public HelperDescriptor(Type helperType)
  33                 {
  34                         this.helperType = helperType;
  35                 }
  36
  37                 /// <summary>
  38                 /// Initializes a new instance of the <see cref="HelperDescriptor"/> class.
  39                 /// </summary>
  40                 /// <param name="helperType">Type of the helper.</param>
  41                 /// <param name="name">A custom name to use to access the helper from the view.</param>
  42                 public HelperDescriptor(Type helperType, String name) : this(helperType)
  43                 {
  44                         this.name = name;
  45                 }
  46
  47                 /// <summary>
  48                 /// Gets the helper name.
  49                 /// </summary>
  50                 /// <value>The name.</value>
  51                 public string Name
  52                 {
  53                         get { return name; }
  54                 }
  55
  56                 /// <summary>
  57                 /// Gets the type of the helper.
  58                 /// </summary>
  59                 /// <value>The type of the helper.</value>
  60                 public Type HelperType
  61                 {
  62                         get { return helperType; }
  63                 }
  64         }
  65 }