File: ConfigModel\BaseReplaceSymbol.cs
Web Access
Project: src\sdk\src\TemplateEngine\Microsoft.TemplateEngine.Orchestrator.RunnableProjects\Microsoft.TemplateEngine.Orchestrator.RunnableProjects.csproj (Microsoft.TemplateEngine.Orchestrator.RunnableProjects)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Text.Json.Nodes;

namespace Microsoft.TemplateEngine.Orchestrator.RunnableProjects.ConfigModel
{
    public abstract class BaseReplaceSymbol : BaseSymbol
    {
        private protected BaseReplaceSymbol(string name, string? replaces) : base(name)
        {
            ReplacementContexts = [];
            Replaces = replaces;
        }

        private protected BaseReplaceSymbol(BaseReplaceSymbol clone) : base(clone)
        {
            FileRename = clone.FileRename;
            Replaces = clone.Replaces;
            ReplacementContexts = clone.ReplacementContexts;
        }

        private protected BaseReplaceSymbol(JsonObject jObject, string name) : base(name)
        {
            FileRename = jObject.ToString(nameof(FileRename));
            Replaces = jObject.ToString(nameof(Replaces));
            ReplacementContexts = ReplacementContext.FromJObject(jObject);
        }

        /// <summary>
        /// Gets the text that should be replaced by the value of this symbol.
        /// Corresponds to "replaces" JSON property.
        /// </summary>
        public string? Replaces { get; }

        /// <summary>
        /// Gets the replacement contexts that determine when this symbol is allowed to do replacement operations.
        /// </summary>
        public IReadOnlyList<ReplacementContext> ReplacementContexts { get; }

        /// <summary>
        /// Gets the part of the file name that should be replaced with the value of this symbol.
        /// Corresponds to "fileRename" JSON property.
        /// </summary>
        public string? FileRename { get; }
    }
}