mcs/class/System.ComponentModel.DataAnnotations/System.ComponentModel.DataAnnotations/StringLengthAttribute.cs

   1 //
   2 // StringLengthAttribute.cs
   3 //
   4 // Author:
   5 //      Atsushi Enomoto <atsushi@ximian.com>
   6 //      Marek Habersack <grendel@twistedcode.net>
   7 //
   8 // Copyright (C) 2008-2010 Novell Inc. http://novell.com
   9 //
  10
  11 //
  12 // Permission is hereby granted, free of charge, to any person obtaining
  13 // a copy of this software and associated documentation files (the
  14 // "Software"), to deal in the Software without restriction, including
  15 // without limitation the rights to use, copy, modify, merge, publish,
  16 // distribute, sublicense, and/or sell copies of the Software, and to
  17 // permit persons to whom the Software is furnished to do so, subject to
  18 // the following conditions:
  19 //
  20 // The above copyright notice and this permission notice shall be
  21 // included in all copies or substantial portions of the Software.
  22 //
  23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  27 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  28 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  29 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  30 //
  31 using System;
  32 using System.ComponentModel;
  33
  34 namespace System.ComponentModel.DataAnnotations
  35 {
  36         [AttributeUsage (AttributeTargets.Property|AttributeTargets.Field, AllowMultiple = false)]
  37         public class StringLengthAttribute : ValidationAttribute
  38         {
  39                 public int MaximumLength { get; private set; }
  40 #if NET_4_0
  41                 public int MinimumLength { get; set; }
  42 #endif
  43                 public StringLengthAttribute (int maximumLength)
  44                         : base (GetDefaultErrorMessage)
  45                 {
  46 #if !NET_4_0
  47                         if (maximumLength < 0)
  48                                 throw new ArgumentOutOfRangeException ("maximumLength", String.Format ("Actual value was {0}", maximumLength));
  49 #endif
  50                         MaximumLength = maximumLength;
  51                 }
  52
  53                 static string GetDefaultErrorMessage ()
  54                 {
  55                         return "The field {0} must be a string with a maximum length of {1}.";
  56                 }
  57
  58                 public override string FormatErrorMessage (string name)
  59                 {
  60 #if NET_4_0
  61                         return String.Format (ErrorMessageString, name, MaximumLength, MinimumLength);
  62 #else
  63                         return String.Format (ErrorMessageString, name, MaximumLength);
  64 #endif
  65                 }
  66
  67                 public override bool IsValid (object value)
  68                 {
  69                         if (value == null)
  70                                 return true;
  71
  72                         string str = (string)value;
  73                         int max = MaximumLength;
  74 #if NET_4_0
  75                         int min = MinimumLength;
  76
  77                         // LAMESPEC: documented to throw ArgumentOutOfRangeException
  78                         if (max < 0)
  79                                 throw new InvalidOperationException ("The maximum length must be a nonnegative integer.");
  80
  81                         if (min > max)
  82                                 throw new InvalidOperationException (
  83                                         String.Format ("The maximum value '{0}' must be greater than or equal to the minimum value '{1}'.",
  84                                                        max, min)
  85                                 );
  86
  87                         int len = str.Length;
  88                         return len <= max && len >= min;
  89 #else
  90                         return str.Length <= max;
  91 #endif
  92                 }
  93         }
  94 }