MonoRail/Castle.MonoRail.Framework/CacheKey.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         /// <summary>
  18         /// Represents a Cache Key.
  19         /// </summary>
  20         /// <remarks>
  21         /// Implementors just need to override the <c>ToString</c>
  22         /// method. The cache key should be immutable and deterministic.
  23         /// </remarks>
  24         public abstract class CacheKey
  25         {
  26                 /// <summary>
  27                 /// Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  28                 /// </summary>
  29                 /// <returns>
  30                 /// A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  31                 /// </returns>
  32                 public abstract new string ToString();
  33         }
  34
  35         /// <summary>
  36         /// A simple <see cref="CacheKey"/> implementation.
  37         /// </summary>
  38         public class NamedCacheKey : CacheKey
  39         {
  40                 private readonly string name;
  41
  42                 /// <summary>
  43                 /// Initializes a new instance of the <see cref="NamedCacheKey"/> class.
  44                 /// </summary>
  45                 /// <param name="name">Key name/content.</param>
  46                 public NamedCacheKey(string name)
  47                 {
  48                         this.name = name;
  49                 }
  50
  51                 /// <summary>
  52                 /// Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  53                 /// </summary>
  54                 /// <returns>
  55                 /// A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  56                 /// </returns>
  57                 public override string ToString()
  58                 {
  59                         return name;
  60                 }
  61         }
  62 }