1 // ***********************************************************************
2 // Copyright (c) 2007 Charlie Poole
4 // Permission is hereby granted, free of charge, to any person obtaining
5 // a copy of this software and associated documentation files (the
6 // "Software"), to deal in the Software without restriction, including
7 // without limitation the rights to use, copy, modify, merge, publish,
8 // distribute, sublicense, and/or sell copies of the Software, and to
9 // permit persons to whom the Software is furnished to do so, subject to
10 // the following conditions:
12 // The above copyright notice and this permission notice shall be
13 // included in all copies or substantial portions of the Software.
15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
19 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
20 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
21 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 // ***********************************************************************
25 #define NUNIT_FRAMEWORK
31 namespace NUnit.Framework.Constraints
34 /// TypeConstraint is the abstract base for constraints
35 /// that take a Type as their expected value.
37 public abstract class TypeConstraint : Constraint
40 /// The expected Type used by the constraint
42 protected Type expectedType;
45 /// The type of the actual argument to which the constraint was applied
47 protected Type actualType;
50 /// Construct a TypeConstraint for a given Type
52 /// <param name="type">The expected type for the constraint</param>
53 /// <param name="descriptionPrefix">Prefix used in forming the constraint description</param>
54 protected TypeConstraint(Type type, string descriptionPrefix)
57 this.expectedType = type;
58 this.Description = descriptionPrefix + MsgUtils.FormatValue(expectedType);
62 /// Applies the constraint to an actual value, returning a ConstraintResult.
64 /// <param name="actual">The value to be tested</param>
65 /// <returns>A ConstraintResult</returns>
66 public override ConstraintResult ApplyTo<TActual>(TActual actual)
68 actualType = actual == null ? null : actual.GetType();
69 return new ConstraintResult(this, actualType, this.Matches(actual));
73 /// Apply the constraint to an actual value, returning true if it succeeds
75 /// <param name="actual">The actual argument</param>
76 /// <returns>True if the constraint succeeds, otherwise false.</returns>
77 protected abstract bool Matches(object actual);