IFileSystem: Added exception documentation

This commit is contained in:
Tal Aloni 2017-02-09 12:54:19 +02:00
parent 3baf91238d
commit f1965ec7ca

View file

@ -6,14 +6,60 @@ namespace Utilities
{
public interface IFileSystem
{
/// <exception cref="System.ArgumentException"></exception>
/// <exception cref="System.IO.IOException"></exception>
/// <exception cref="System.UnauthorizedAccessException"></exception>
FileSystemEntry GetEntry(string path);
/// <exception cref="System.ArgumentException"></exception>
/// <exception cref="System.IO.DirectoryNotFoundException"></exception>
/// <exception cref="System.IO.IOException"></exception>
/// <exception cref="System.UnauthorizedAccessException"></exception>
FileSystemEntry CreateFile(string path);
/// <exception cref="System.ArgumentException"></exception>
/// <exception cref="System.IO.DirectoryNotFoundException"></exception>
/// <exception cref="System.IO.IOException"></exception>
/// <exception cref="System.UnauthorizedAccessException"></exception>
FileSystemEntry CreateDirectory(string path);
/// <exception cref="System.ArgumentException"></exception>
/// <exception cref="System.IO.DirectoryNotFoundException"></exception>
/// <exception cref="System.IO.FileNotFoundException"></exception>
/// <exception cref="System.IO.IOException"></exception>
/// <exception cref="System.UnauthorizedAccessException"></exception>
void Move(string source, string destination);
/// <exception cref="System.ArgumentException"></exception>
/// <exception cref="System.IO.DirectoryNotFoundException"></exception>
/// <exception cref="System.IO.FileNotFoundException"></exception>
/// <exception cref="System.IO.IOException"></exception>
/// <exception cref="System.UnauthorizedAccessException"></exception>
void Delete(string path);
/// <exception cref="System.ArgumentException"></exception>
/// <exception cref="System.IO.DirectoryNotFoundException"></exception>
/// <exception cref="System.IO.IOException"></exception>
/// <exception cref="System.UnauthorizedAccessException"></exception>
List<FileSystemEntry> ListEntriesInDirectory(string path);
/// <exception cref="System.ArgumentException"></exception>
/// <exception cref="System.IO.DirectoryNotFoundException"></exception>
/// <exception cref="System.IO.FileNotFoundException"></exception>
/// <exception cref="System.IO.IOException"></exception>
/// <exception cref="System.UnauthorizedAccessException"></exception>
Stream OpenFile(string path, FileMode mode, FileAccess access, FileShare share);
/// <exception cref="System.ArgumentException"></exception>
/// <exception cref="System.IO.FileNotFoundException"></exception>
/// <exception cref="System.IO.IOException"></exception>
/// <exception cref="System.UnauthorizedAccessException"></exception>
void SetAttributes(string path, bool? isHidden, bool? isReadonly, bool? isArchived);
/// <exception cref="System.ArgumentException"></exception>
/// <exception cref="System.IO.FileNotFoundException"></exception>
/// <exception cref="System.IO.IOException"></exception>
/// <exception cref="System.UnauthorizedAccessException"></exception>
void SetDates(string path, DateTime? creationDT, DateTime? lastWriteDT, DateTime? lastAccessDT);
string Name
@ -21,11 +67,13 @@ namespace Utilities
get;
}
/// <exception cref="System.IO.IOException"></exception>
long Size
{
get;
}
/// <exception cref="System.IO.IOException"></exception>
long FreeSpace
{
get;