CodeTreeRequest.cs

using EnvDTE;
using SteveCadwallader.CodeMaid.Model.CodeItems;

namespace SteveCadwallader.CodeMaid.Model.CodeTree
{
    /// <summary>
    /// A simple class for containing a request to build a code tree.
    /// </summary>
    internal class CodeTreeRequest
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="CodeTreeRequest" /> class.
        /// </summary>
        /// <param name="document">The document.</param>
        /// <param name="rawCodeItems">The raw code items.</param>
        /// <param name="sortOrder">The sort order.</param>
        /// <param name="nameFilter">The name filter.</param>
        internal CodeTreeRequest(Document document, SetCodeItems rawCodeItems, CodeSortOrder sortOrder, string nameFilter = null)
        {
            Document = document;
            RawCodeItems = rawCodeItems;
            SortOrder = sortOrder;
            NameFilter = nameFilter;
        }

        /// <summary>
        /// Gets the document.
        /// </summary>
        internal Document Document { get; private set; }

        /// <summary>
        /// Gets the raw code items.
        /// </summary>
        internal SetCodeItems RawCodeItems { get; private set; }

        /// <summary>
        /// Gets the sort order.
        /// </summary>
        internal CodeSortOrder SortOrder { get; private set; }

        /// <summary>
        /// Gets the name filter.
        /// </summary>
        internal string NameFilter { get; private set; }
    }
}