EpubReader/Source/VersOne.Epub/Options/PackageReaderOptions.cs

using System.Diagnostics.CodeAnalysis;

namespace VersOne.Epub.Options
{
    /// <summary>
    /// Various options to configure the behavior of the EPUB package reader.
    /// </summary>
    public class PackageReaderOptions
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="PackageReaderOptions" /> class.
        /// </summary>
        /// <param name="preset">An optional preset to initialize the <see cref="PackageReaderOptions" /> class with a predefined set of options.</param>
        [SuppressMessage("Style", "IDE0060:Remove unused parameter", Justification = "Temporarily ignore unused 'preset' parameter.")]
        public PackageReaderOptions(EpubReaderOptionsPreset? preset = null)
        {
            IgnoreMissingToc = false;
            SkipInvalidManifestItems = false;
        }

        /// <summary>
        /// Gets or sets a value indicating whether the package reader should ignore missing TOC attribute in the EPUB 2 spine.
        /// If it's set to <c>false</c> and the TOC attribute is not present, then the "Incorrect EPUB spine: TOC is missing" exception will be thrown.
        /// Default value is <c>false</c>.
        /// </summary>
        public bool IgnoreMissingToc { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether the package reader should skip EPUB manifest items that are missing required attributes (id, href, or media-type).
        /// If it's set to <c>false</c> and one of the required attributes is not present, then one of the "Incorrect EPUB manifest: item ... is missing" exceptions will be thrown.
        /// Default value is <c>false</c>.
        /// </summary>
        public bool SkipInvalidManifestItems { get; set; }
    }
}