SimplePack Library

using System;
using System.ComponentModel;
using SimplePack.Exceptions;

namespace SimplePack.Events
{
    ///<summary>
    /// Delegate which wrap <see cref="RemoveDirectoryCompletedEventArgs"/> event argument.
    ///</summary>
    ///<param name="sender"></param>
    ///<param name="removeDirectoryCompletedEventArgs"></param>
    public delegate void RemoveDirectoryCompletedEventHandler(
        Archive sender, RemoveDirectoryCompletedEventArgs removeDirectoryCompletedEventArgs);

    ///<summary>
    /// Asynchronous Event Argument which is invoked when removing directory from Archive is done.
    ///</summary>
    public class RemoveDirectoryCompletedEventArgs : AsyncCompletedEventArgs
    {
        private readonly string directoryArchivePath;

        ///<summary>
        /// Constructor.
        ///<list type="table">
        /// <listheader>
        /// <term>Exceptions in Error</term>
        /// <description>Conditions</description>
        /// </listheader>
        ///<item>
        /// <term><see cref="ArchivePathException"/></term>
        /// <description><paramref name="directoryArchivePath"/> is not correct</description>
        ///</item>
        ///<item>
        /// <term><see cref="ArchiveFileNotFoundException"/></term>
        /// <description>archive path is syntactically correct but File not exist in archive</description>
        ///</item> 
        ///<item>
        /// <term><see cref="ArchiveConsistencyException"/></term>
        /// <description>removed file have different size than expected</description>
        ///</item> 
        ///<item>
        /// <term><see cref="ArchiveNotOpenedException"/></term>
        /// <description>Archive must be opened first</description>
        ///</item>
        ///</list>
        ///</summary>
        ///<param name="directoryArchivePath">Path to directory which will be removed from archive</param>
        ///<param name="error">Exception occurred during performing asynchronous operation</param>
        ///<param name="canceled"><see langword="true"/> if operation was canceled (unused)</param>
        ///<param name="userState">unused</param>
        public RemoveDirectoryCompletedEventArgs(string directoryArchivePath, Exception error, bool canceled, object userState) : base(error, canceled, userState)
        {
            this.directoryArchivePath = directoryArchivePath;
        }

        ///<summary>
        /// Path to directory which will be removed from archive.
        ///</summary>
        public string DirectoryArchivePath
        {
            get { return directoryArchivePath; }
        }
    }
}