/* <copyright>
Copyright (c) 2012, Motorola Mobility LLC.
All Rights Reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

* Neither the name of Motorola Mobility LLC nor the names of its
  contributors may be used to endorse or promote products derived from this
  software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
</copyright> */
/**
    Defines extensions to native String object.
    @see [String class]{@link external:String}
    @module montage/core/shim/string
*/

/**
 @external String
 */
Object.defineProperties(String.prototype, /** @lends external:String.prototype#*/{
    /**
    @function external:String.addEventListener
    @param {Listener} type The type of event listener.
    @param {Listener} listener The event listener.
    @param {Function} useCapture The capturing function.
    */
    addEventListener: {
        value: function(type, listener, useCapture) {
            //NO OP, on purpose
        }

    },
    /**
     Capitalizes the first letter in the string.
     @function external:String.toCapitalized
     @returns {String} The original string with its first letter capitalized.
     @example
     var fname = "abe";
     var lname = "lincoln";
     var name = fname.toCapitalized() + " " + lname.toCapitalized();
     // name == "Abe Lincoln"
     */
    toCapitalized: {
        value: function() {
            return this.charAt(0).toUpperCase() + this.slice(1);
        }
    },

    /**
     Returns true if the two strings are equal, otherwise returns false.
     @function external:String.equals
     @param {Object} anObject The object to compare to the string.
     @returns {Boolean} Returns true if the string is equal to <code>anObject</code>.
     */
    equals: {
        value: function(anObject) {
            if (this.toString() === anObject) {
                return true;
            }

            if (!anObject || !(anObject instanceof String)) {
                return false;
            }

            return (this == anObject);
        }
    }

});

/**
    Shim implementation of String.isString() for browsers that don't yet support it.
    @function external:String.isString()
    @param {object} obj The object to determine if its a String.
    @returns {boolean} Object.prototype.toString.call(obj) === "[object String]"
*/
if (!String.isString) {
    Object.defineProperty(String, "isString", {
        value: function(obj) {
            return Object.prototype.toString.call(obj) === "[object String]";
        }
    });
}