test/Tizen.NUI.Devel.Tests.Ubuntu/nunit.framework/Constraints/IConstraint.cs

   1 // ***********************************************************************
   2 // Copyright (c) 2012 Charlie Poole
   3 //
   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:
  11 //
  12 // The above copyright notice and this permission notice shall be
  13 // included in all copies or substantial portions of the Software.
  14 //
  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 // ***********************************************************************
  23 #define PORTABLE
  24 #define TIZEN
  25 #define NUNIT_FRAMEWORK
  26 #define NUNITLITE
  27 #define NET_4_5
  28 #define PARALLEL
  29 namespace NUnit.Framework.Constraints
  30 {
  31     /// <summary>
  32     /// Interface for all constraints
  33     /// </summary>
  34     public interface IConstraint : IResolveConstraint
  35     {
  36         #region Properties
  37
  38         /// <summary>
  39         /// The display name of this Constraint for use by ToString().
  40         /// </summary>
  41         string DisplayName { get; }
  42
  43         /// <summary>
  44         /// The Description of what this constraint tests, for
  45         /// use in messages and in the ConstraintResult.
  46         /// </summary>
  47         string Description { get; }
  48
  49         /// <summary>
  50         /// Arguments provided to this Constraint, for use in
  51         /// formatting the description.
  52         /// </summary>
  53         object[] Arguments { get; }
  54
  55         /// <summary>
  56         /// The ConstraintBuilder holding this constraint
  57         /// </summary>
  58         ConstraintBuilder Builder { get; set; }
  59
  60         #endregion
  61
  62         #region Methods
  63
  64         /// <summary>
  65         /// Applies the constraint to an actual value, returning a ConstraintResult.
  66         /// </summary>
  67         /// <param name="actual">The value to be tested</param>
  68         /// <returns>A ConstraintResult</returns>
  69         ConstraintResult ApplyTo<TActual>(TActual actual);
  70
  71         /// <summary>
  72         /// Applies the constraint to an ActualValueDelegate that returns
  73         /// the value to be tested. The default implementation simply evaluates
  74         /// the delegate but derived classes may override it to provide for
  75         /// delayed processing.
  76         /// </summary>
  77         /// <param name="del">An ActualValueDelegate</param>
  78         /// <returns>A ConstraintResult</returns>
  79         ConstraintResult ApplyTo<TActual>(ActualValueDelegate<TActual> del);
  80
  81         #pragma warning disable 3006
  82         /// <summary>
  83         /// Test whether the constraint is satisfied by a given reference.
  84         /// The default implementation simply dereferences the value but
  85         /// derived classes may override it to provide for delayed processing.
  86         /// </summary>
  87         /// <param name="actual">A reference to the value to be tested</param>
  88         /// <returns>A ConstraintResult</returns>
  89         ConstraintResult ApplyTo<TActual>(ref TActual actual);
  90         #pragma warning restore 3006
  91
  92         #endregion
  93     }
  94 }