// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System.Collections.Generic;
using Microsoft.Framework.Internal;

namespace Microsoft.AspNet.Mvc.Razor
{
    /// <summary>
    /// Represents the results of locating a <see cref="IRazorPage"/>.
    /// </summary>
    public class RazorPageResult
    {
        /// <summary>
        /// Initializes a new instance of <see cref="RazorPageResult"/> for a successful discovery.
        /// </summary>
        /// <param name="name">The name of the page that was located.</param>
        /// <param name="page">The located <see cref="IRazorPage"/>.</param>
        public RazorPageResult([NotNull] string name, [NotNull] IRazorPage page)
        {
            Name = name;
            Page = page;
        }

        /// <summary>
        /// Initializes a new instance of <see cref="RazorPageResult"/> for an unsuccessful discovery.
        /// </summary>
        /// <param name="name">The name of the page that was located.</param>
        /// <param name="page">The locations that were searched.</param>
        public RazorPageResult([NotNull] string name, [NotNull] IEnumerable<string> searchedLocations)
        {
            Name = name;
            SearchedLocations = searchedLocations;
        }

        /// <summary>
        /// Gets the name of the page being located.
        /// </summary>
        /// <remarks>This property maps to the <c>name</c> parameter of
        /// <see cref="IRazorViewEngine.FindPage(ActionContext, string)"/>.</remarks>
        public string Name { get; }

        /// <summary>
        /// Gets the <see cref="IRazorPage"/> if found.
        /// </summary>
        /// <remarks>This property is <c>null</c> if the page was not found.</remarks>
        public IRazorPage Page { get; }

        /// <summary>
        /// Gets the locations that were searched when <see cref="Page"/> could not be located.
        /// </summary>
        /// <remarks>This property is <c>null</c> if the page was found.</remarks>
        public IEnumerable<string> SearchedLocations { get; }
    }
}