API Docs for: 3.10.3
Show:

File: test/js/UnexpectedValue.js

  1. /**
  2.  * UnexpectedValue is subclass of Error that is thrown whenever
  3.  * a value was unexpected in its scope. This typically means that a test
  4.  * was performed to determine that a value was *not* equal to a certain
  5.  * value.
  6.  *
  7.  * @param {String} message The message to display when the error occurs.
  8.  * @param {Object} unexpected The unexpected value.
  9.  * @namespace Test 
  10.  * @extends AssertionError
  11.  * @module test
  12.  * @class UnexpectedValue
  13.  * @constructor
  14.  */ 
  15. YUITest.UnexpectedValue = function (message, unexpected){
  16.  
  17.     //call superclass
  18.     YUITest.AssertionError.call(this, message);
  19.     
  20.     /**
  21.      * The unexpected value.
  22.      * @type Object
  23.      * @property unexpected
  24.      */
  25.     this.unexpected = unexpected;
  26.     
  27.     /**
  28.      * The name of the error that occurred.
  29.      * @type String
  30.      * @property name
  31.      */
  32.     this.name = "UnexpectedValue";
  33.     
  34. };
  35.  
  36. //inherit from YUITest.AssertionError
  37. YUITest.UnexpectedValue.prototype = new YUITest.AssertionError();
  38.  
  39. //restore constructor
  40. YUITest.UnexpectedValue.prototype.constructor = YUITest.UnexpectedValue;
  41.  
  42. /**
  43.  * Returns a fully formatted error for an assertion failure. This message
  44.  * provides information about the expected and actual values.
  45.  * @method getMessage
  46.  * @return {String} A string describing the error.
  47.  */
  48. YUITest.UnexpectedValue.prototype.getMessage = function(){
  49.     return this.message + "\nUnexpected: " + this.unexpected + " (" + (typeof this.unexpected) + ") ";
  50. };
  51.  
  52.