/* <copyright>
 This file contains proprietary software owned by Motorola Mobility, Inc.<br/>
 No rights, expressed or implied, whatsoever to this software are provided by Motorola Mobility, Inc. hereunder.<br/>
 (c) Copyright 2011 Motorola Mobility, Inc.  All Rights Reserved.
 </copyright> */
/**
	@module montage/core/converter/new-line-to-br-converter
    @requires montage/core/core
    @requires montage/core/converter/converter
*/

var Montage = require("montage").Montage;
var Converter = require('core/converter/converter').Converter;

/**
    Replaces all new line characters with a HTML &lt;br&gt;
    @memberof module:montage/core/converter#
    @function
    @param {String} str The string to format.
    @returns {String} The formatted string.
 */
var newLineToBr = function(str) {
    return str.replace(/(\r\n|\r|\n)/g, '<br />');
};

/**
 @class module:montage/core/converter/new-line-to-br-converter.NewLineToBrConverter
 @classdesc Converts a newline to a &lt;br&gt; tag.
 */
exports.NewLineToBrConverter = Montage.create(Converter, /** @lends module:montage/core/converter/new-line-to-br-converter.NewLineToBrConverter# */{

    /**
     @private
     */
    _convert: {
        value: function(v) {
            if (v && typeof v === 'string') {
                return newLineToBr(v);
            }
            return v;
        }
    },
    /**
    @function
    @param {String} v Case format
    @returns this._convert(v)
    */
    convert: {value: function(v) {
        return this._convert(v);
    }},

    /**
    @function
    @param {String} v Case format
    @returns this._convert(v)
    */
    revert: {value: function(v) {
        return this._convert(v);
    }}
});