From 4e73d3abe32cd68fe1cee39f5e5c1f40c37a74b1 Mon Sep 17 00:00:00 2001 From: Mauro van der Gun Date: Wed, 9 Aug 2023 10:34:58 -0400 Subject: [PATCH] mark non async methods as obsolete --- FileSystem/src/IFileSystem.cs | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/FileSystem/src/IFileSystem.cs b/FileSystem/src/IFileSystem.cs index 9720f2a..bb2880c 100644 --- a/FileSystem/src/IFileSystem.cs +++ b/FileSystem/src/IFileSystem.cs @@ -1,3 +1,4 @@ +using System; using System.Collections.Generic; using System.Threading; using System.Threading.Tasks; @@ -37,6 +38,7 @@ public interface IFileSystem /// Thrown when an adapter could not be found via the provided prefix. /// Thrown when a prefix in the provided path could not be found. /// Thrown if the file does not exists at the given path. + [Obsolete("Method is deprecated, please use the async version instead. Method will be removed in v2.0.")] public IFile GetFile(string virtualPath); /// @@ -66,6 +68,7 @@ public interface IFileSystem /// Thrown when an adapter could not be found via the provided prefix. /// Thrown when a prefix in the provided path could not be found. /// Thrown if the directory does not exists at the given path. + [Obsolete("Method is deprecated, please use the async version instead. Method will be removed in v2.0.")] public IDirectory GetDirectory(string virtualPath); /// @@ -95,6 +98,7 @@ public interface IFileSystem /// Thrown when an adapter could not be found via the provided prefix. /// Thrown when a prefix in the provided path could not be found. /// Thrown if the directory does not exists at the given path. + [Obsolete("Method is deprecated, please use the async version instead. Method will be removed in v2.0.")] public IEnumerable GetFiles(string virtualPath = ""); /// @@ -124,6 +128,7 @@ public interface IFileSystem /// Thrown when an adapter could not be found via the provided prefix. /// Thrown when a prefix in the provided path could not be found. /// Thrown if the directory does not exists at the given path. + [Obsolete("Method is deprecated, please use the async version instead. Method will be removed in v2.0.")] public IEnumerable GetDirectories(string virtualPath = ""); /// @@ -152,6 +157,7 @@ public interface IFileSystem /// Thrown when multiple adapters are registered with the same prefix. /// Thrown when an adapter could not be found via the provided prefix. /// Thrown when a prefix in the provided path could not be found. + [Obsolete("Method is deprecated, please use the async version instead. Method will be removed in v2.0.")] public bool FileExists(string virtualPath); /// @@ -179,6 +185,7 @@ public interface IFileSystem /// Thrown when multiple adapters are registered with the same prefix. /// Thrown when an adapter could not be found via the provided prefix. /// Thrown when a prefix in the provided path could not be found. + [Obsolete("Method is deprecated, please use the async version instead. Method will be removed in v2.0.")] public bool DirectoryExists(string virtualPath); /// @@ -206,6 +213,7 @@ public interface IFileSystem /// Thrown when an adapter could not be found via the provided prefix. /// Thrown when a prefix in the provided path could not be found. /// Thrown if the directory exists at the given path. + [Obsolete("Method is deprecated, please use the async version instead. Method will be removed in v2.0.")] public void CreateDirectory(string virtualPath); /// @@ -233,6 +241,7 @@ public interface IFileSystem /// Thrown when an adapter could not be found via the provided prefix. /// Thrown when a prefix in the provided path could not be found. /// Thrown if the file does not exists at the given path. + [Obsolete("Method is deprecated, please use the async version instead. Method will be removed in v2.0.")] public void DeleteFile(string virtualPath); /// @@ -260,6 +269,7 @@ public interface IFileSystem /// Thrown when an adapter could not be found via the provided prefix. /// Thrown when a prefix in the provided path could not be found. /// Thrown if the directory does not exists at the given path. + [Obsolete("Method is deprecated, please use the async version instead. Method will be removed in v2.0.")] public void DeleteDirectory(string virtualPath); /// @@ -288,6 +298,7 @@ public interface IFileSystem /// Thrown when an adapter could not be found via the provided prefix. /// Thrown when a prefix in the provided path could not be found. /// Thrown if the file does not exists at the given path. + [Obsolete("Method is deprecated, please use the async version instead. Method will be removed in v2.0.")] public byte[] ReadFile(string virtualPath); /// @@ -317,6 +328,7 @@ public interface IFileSystem /// Thrown when an adapter could not be found via the provided prefix. /// Thrown when a prefix in the provided path could not be found. /// Thrown if the file does not exists at the given path. + [Obsolete("Method is deprecated, please use the async version instead. Method will be removed in v2.0.")] public string ReadTextFile(string virtualPath); /// @@ -348,6 +360,7 @@ public interface IFileSystem /// Thrown when a prefix in the provided path could not be found. /// Thrown if the file does not exists at the given path. /// Thrown if the file exists at the given path and parameter "overwrite" = false. + [Obsolete("Method is deprecated, please use the async version instead. Method will be removed in v2.0.")] public void CopyFile(string virtualSourcePath, string virtualDestinationPath, bool overwrite = false); /// @@ -381,6 +394,7 @@ public interface IFileSystem /// Thrown when a prefix in the provided path could not be found. /// Thrown if the file does not exists at the given path. /// Thrown if the file exists at the given path and parameter "overwrite" = false. + [Obsolete("Method is deprecated, please use the async version instead. Method will be removed in v2.0.")] public void MoveFile(string virtualSourcePath, string virtualDestinationPath, bool overwrite = false); /// @@ -413,6 +427,7 @@ public interface IFileSystem /// Thrown when an adapter could not be found via the provided prefix. /// Thrown when a prefix in the provided path could not be found. /// Thrown if the file exists at the given path and parameter "overwrite" = false. + [Obsolete("Method is deprecated, please use the async version instead. Method will be removed in v2.0.")] public void WriteFile(string virtualPath, byte[] contents, bool overwrite = false); /// @@ -444,6 +459,7 @@ public interface IFileSystem /// Thrown when an adapter could not be found via the provided prefix. /// Thrown when a prefix in the provided path could not be found. /// Thrown if the file exists at the given path and parameter "overwrite" = false. + [Obsolete("Method is deprecated, please use the async version instead. Method will be removed in v2.0.")] public void WriteFile(string virtualPath, string contents, bool overwrite = false); /// @@ -474,6 +490,7 @@ public interface IFileSystem /// Thrown when an adapter could not be found via the provided prefix. /// Thrown when a prefix in the provided path could not be found. /// Thrown if the file does not exists at the given path. + [Obsolete("Method is deprecated, please use the async version instead. Method will be removed in v2.0.")] public void AppendFile(string virtualPath, byte[] contents); /// @@ -503,6 +520,7 @@ public interface IFileSystem /// Thrown when an adapter could not be found via the provided prefix. /// Thrown when a prefix in the provided path could not be found. /// Thrown if the file does not exists at the given path. + [Obsolete("Method is deprecated, please use the async version instead. Method will be removed in v2.0.")] public void AppendFile(string virtualPath, string contents); ///