// Copyright (c) 2007 Omer Rauchwerger (a.k.a rauchy) (omer@rauchy.net)
// All rights reserved.
//
// This file is part of Regionerate.
// 
// This program is free software; you can redistribute it and/or modify it 
// under the terms of the GNU General Public License as published by 
// the Free Software Foundation; either version 3 of the License, 
// or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

namespace Rauchy.Regionerate.Shared.Components.Rendering
{
    /// <summary>
    /// A textual sign which can be embedded in strings and later be identified in them.
    /// The <see cref="Prefix"/> symbol adds a prefix to the embedded text.
    /// </summary>
    public sealed class Prefix : Symbol
    {
        #region Fields (1) 

        private readonly string _value;

        #endregion Fields 

        #region Constructors (1) 

        /// <summary>
        /// Initializes a new instance of the <see cref="Prefix"/> class.
        /// </summary>
        /// <param name="value">The prefix value of this <see cref="Prefix"/> symbol.</param>
        public Prefix( string value )
        {
            _value = value;
        }

        #endregion Constructors 

        #region Properties (1) 

        /// <summary>
        /// Gets the prefix value of this <see cref="Prefix"/> symbol.
        /// </summary>
        public string Value
        {
            get
            {
                return _value;
            }
        }

        #endregion Properties 

        #region Methods (2) 

        // Public Methods (2) 

        /// <summary>
        /// Embeds the textual chariteristics of this <see cref="Prefix"/> inside the specified text.
        /// </summary>
        /// <returns>The provided text with the <see cref="Prefix"/> embedded in it.</returns>
        public override string Embed( string text )
        {
            return Value + " " + text;
        }

        /// <summary>
        /// Determines whether the textual chariteristics of this <see cref="Prefix"/> are embedded in the specified text.
        /// </summary>
        public override bool IsEmbeddedIn( string text )
        {
            if ( text.Contains( Value ) )
            {
                return true;
            }
            else
            {
                return false;
            }
        }

        #endregion Methods 
    }
}