#

API Docs for: 3.10.3
Show: Inherited Protected Private Deprecated

# File: test/js/UnexpectedValue.js

    /**
     * UnexpectedValue is subclass of Error that is thrown whenever
     * a value was unexpected in its scope. This typically means that a test
     * was performed to determine that a value was *not* equal to a certain
     * value.
     *
     * @param {String} message The message to display when the error occurs.
     * @param {Object} unexpected The unexpected value.
     * @namespace Test
     * @extends AssertionError
     * @module test
     * @class UnexpectedValue
     * @constructor
     */
    YUITest.UnexpectedValue = function (message, unexpected){

        //call superclass
        YUITest.AssertionError.call(this, message);

        /**
         * The unexpected value.
         * @type Object
         * @property unexpected
         */
        this.unexpected = unexpected;

        /**
         * The name of the error that occurred.
         * @type String
         * @property name
         */
        this.name = "UnexpectedValue";

    };

    //inherit from YUITest.AssertionError
    YUITest.UnexpectedValue.prototype = new YUITest.AssertionError();

    //restore constructor
    YUITest.UnexpectedValue.prototype.constructor = YUITest.UnexpectedValue;

    /**
     * Returns a fully formatted error for an assertion failure. This message
     * provides information about the expected and actual values.
     * @method getMessage
     * @return {String} A string describing the error.
     */
    YUITest.UnexpectedValue.prototype.getMessage = function(){
        return this.message + "\nUnexpected: " + this.unexpected + " (" + (typeof this.unexpected) + ") ";
    };