MustacheSharp/mustache-sharp/InlineTagDefinition.cs

using System;
using System.Collections.Generic;

namespace mustache
{
    /// <summary>
    /// Defines a tag that cannot contain inner text.
    /// </summary>
    public abstract class InlineTagDefinition : TagDefinition
    {
        /// <summary>
        /// Initializes a new instance of an InlineTagDefinition.
        /// </summary>
        /// <param name="tagName">The name of the tag being defined.</param>
        protected InlineTagDefinition(string tagName)
            : base(tagName)
        {
        }

        /// <summary>
        /// Initializes a new instance of an InlineTagDefinition.
        /// </summary>
        /// <param name="tagName">The name of the tag being defined.</param>
        /// <param name="isBuiltin">Specifies whether the tag is a built-in tag.</param>
        internal InlineTagDefinition(string tagName, bool isBuiltin)
            : base(tagName, isBuiltin)
        {
        }

        /// <summary>
        /// Gets or sets whether the tag can have content.
        /// </summary>
        /// <returns>True if the tag can have a body; otherwise, false.</returns>
        protected override bool GetHasContent()
        {
            return false;
        }

        /// <summary>
        /// Generates the text for the tag.
        /// </summary>
        /// <param name="provider">The format provider to use.</param>
        /// <param name="innerText">The text to decorate. This will always be an empty string.</param>
        /// <param name="arguments">The arguments passed to the tag.</param>
        /// <returns>The generated text.</returns>
        public sealed override string Decorate(IFormatProvider provider, string innerText, Dictionary<string, object> arguments)
        {
            return GetText(provider, arguments);
        }

        /// <summary>
        /// Gets the text of the inline tag.
        /// </summary>
        /// <param name="provider">The format provider to use.</param>
        /// <param name="arguments">The arguments passed to the tag.</param>
        /// <returns>The generated text.</returns>
        protected abstract string GetText(IFormatProvider provider, Dictionary<string, object> arguments);
    }
}