MonoRail/Castle.MonoRail.Framework/Attributes/ControllerDetailsAttribute.cs

   1 // Copyright 2004-2007 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         /// Decorates a controller with a different name
  21         /// and optionally an area which the controller belongs to.
  22         /// This is used to override the convention for controller
  23         /// names and to optionally associate a controller with an
  24         /// area name.
  25         /// </summary>
  26         [AttributeUsage(AttributeTargets.Class), Serializable]
  27         public class ControllerDetailsAttribute : Attribute
  28         {
  29                 private String name;
  30                 private String area = String.Empty;
  31
  32                 /// <summary>
  33                 /// Constructs a ControllerDetailsAttribute
  34                 /// </summary>
  35                 public ControllerDetailsAttribute()
  36                 {
  37                 }
  38
  39                 /// <summary>
  40                 /// Constructs a ControllerDetailsAttribute
  41                 /// with a name for the controller.
  42                 /// </summary>
  43                 /// <param name="name">The specified Controller Name</param>
  44                 public ControllerDetailsAttribute( String name )
  45                 {
  46                         this.name = name;
  47                 }
  48
  49                 /// <summary>
  50                 /// The controller's name
  51                 /// </summary>
  52                 public String Name
  53                 {
  54                         get { return name; }
  55                 }
  56
  57                 /// <summary>
  58                 /// The controller's area
  59                 /// </summary>
  60                 public String Area
  61                 {
  62                         get { return area; }
  63                         set { area = value; }
  64                 }
  65         }
  66 }