using System.Collections.Generic;

namespace JD.StringParserService
{
    /// <summary>
    /// A transform is an operation made on a parsed tag before being returned.
    /// </summary>
    public interface IStringParserTransform
    {
        #region Properties

        /// <summary>
        /// The tags recognized by this transform.
        /// </summary>
        IEnumerable<string> Tags { get; }

        #endregion

        #region Methods

        /// <summary>
        /// Transform the given <paramref name="text"/> using the given <paramref name="tag"/>.
        /// </summary>
        /// <param name="text"></param>
        /// <param name="tag"></param>
        /// <returns></returns>
        string Transform(string text, string tag);

        #endregion
    }
}