Add string format ctor to all exceptions and change existing usages

Oded Welgreen · Oded Welgreen · commit 0625b7f868ab · 2015-10-20T16:19:59.000+03:00
diff --git a/LibGit2Sharp/BareRepositoryException.cs b/LibGit2Sharp/BareRepositoryException.cs
@@ -25,6 +25,15 @@ public BareRepositoryException(string message)
             : base(message)
         { }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="LibGit2Sharp.BareRepositoryException"/> class with a specified error message.
+        /// </summary>
+        /// <param name="format">A composite format string for use in <see cref="String.Format(IFormatProvider, string, object[])"/>.</param>
+        /// <param name="args">An object array that contains zero or more objects to format.</param>
+        public BareRepositoryException(string format, params object[] args)
+            : base(format, args)
+        { }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="LibGit2Sharp.BareRepositoryException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
         /// </summary>
diff --git a/LibGit2Sharp/CheckoutConflictException.cs b/LibGit2Sharp/CheckoutConflictException.cs
@@ -26,6 +26,15 @@ public CheckoutConflictException(string message)
             : base(message)
         { }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="LibGit2Sharp.CheckoutConflictException"/> class with a specified error message.
+        /// </summary>
+        /// <param name="format">A composite format string for use in <see cref="String.Format(IFormatProvider, string, object[])"/>.</param>
+        /// <param name="args">An object array that contains zero or more objects to format.</param>
+        public CheckoutConflictException(string format, params object[] args)
+            : base(format, args)
+        { }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="LibGit2Sharp.CheckoutConflictException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
         /// </summary>
diff --git a/LibGit2Sharp/Core/Ensure.cs b/LibGit2Sharp/Core/Ensure.cs
@@ -261,16 +261,14 @@ public static void GitObjectIsNotNull(GitObject gitObject, string identifier)
                 return;
             }
 
-            var message = string.Format(CultureInfo.InvariantCulture,
-                                        "No valid git object identified by '{0}' exists in the repository.",
-                                        identifier);
-
+            var messageFormat = "No valid git object identified by '{0}' exists in the repository.";
+                                        
             if (string.Equals("HEAD", identifier, StringComparison.Ordinal))
             {
-                throw new UnbornBranchException(message);
+                throw new UnbornBranchException(messageFormat, identifier);
             }
 
-            throw new NotFoundException(message);
+            throw new NotFoundException(messageFormat, identifier);
         }
     }
 }
diff --git a/LibGit2Sharp/Core/Proxy.cs b/LibGit2Sharp/Core/Proxy.cs
@@ -823,8 +823,7 @@ public static void git_filter_register(string name, IntPtr filterPtr, int priori
             int res = NativeMethods.git_filter_register(name, filterPtr, priority);
             if (res == (int)GitErrorCode.Exists)
             {
-                var message = String.Format("A filter with the name '{0}' is already registered", name);
-                throw new EntryExistsException(message);
+                throw new EntryExistsException("A filter with the name '{0}' is already registered", name);
             }
             Ensure.ZeroResult(res);
         }
@@ -2256,7 +2255,7 @@ public static void git_remote_rename(RepositorySafeHandle repo, string name, str
 
                 if (res == (int)GitErrorCode.NotFound)
                 {
-                    throw new NotFoundException(string.Format("Remote '{0}' does not exist and cannot be renamed.", name));
+                    throw new NotFoundException("Remote '{0}' does not exist and cannot be renamed.", name);
                 }
 
                 Ensure.ZeroResult(res);
@@ -2404,9 +2403,8 @@ public static RepositorySafeHandle git_repository_open(string path)
 
             if (res == (int)GitErrorCode.NotFound)
             {
-                throw new RepositoryNotFoundException(String.Format(CultureInfo.InvariantCulture,
-                                                                    "Path '{0}' doesn't point at a valid Git repository or workdir.",
-                                                                    path));
+                throw new RepositoryNotFoundException("Path '{0}' doesn't point at a valid Git repository or workdir.",
+                                                                    path);
             }
 
             Ensure.ZeroResult(res);
@@ -2435,9 +2433,8 @@ public static void git_repository_open_ext(string path, RepositoryOpenFlags flag
 
             if (res == (int)GitErrorCode.NotFound)
             {
-                throw new RepositoryNotFoundException(String.Format(CultureInfo.InvariantCulture,
-                                                                    "Path '{0}' doesn't point at a valid Git repository or workdir.",
-                                                                    path));
+                throw new RepositoryNotFoundException("Path '{0}' doesn't point at a valid Git repository or workdir.",
+                                                                    path);
             }
 
             Ensure.ZeroResult(res);
@@ -3076,8 +3073,8 @@ public static void git_transport_register(String prefix, IntPtr transport_cb, In
 
             if (res == (int)GitErrorCode.Exists)
             {
-                throw new EntryExistsException(String.Format("A custom transport for '{0}' is already registered",
-                    prefix));
+                throw new EntryExistsException("A custom transport for '{0}' is already registered",
+                    prefix);
             }
 
             Ensure.ZeroResult(res);
diff --git a/LibGit2Sharp/EmptyCommitException.cs b/LibGit2Sharp/EmptyCommitException.cs
@@ -24,6 +24,15 @@ public EmptyCommitException(string message)
             : base(message)
         { }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="EmptyCommitException"/> class with a specified error message.
+        /// </summary>
+        /// <param name="format">A composite format string for use in <see cref="String.Format(IFormatProvider, string, object[])"/>.</param>
+        /// <param name="args">An object array that contains zero or more objects to format.</param>
+        public EmptyCommitException(string format, params object[] args)
+            : base(format, args)
+        { }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="EmptyCommitException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
         /// </summary>
diff --git a/LibGit2Sharp/EntryExistsException.cs b/LibGit2Sharp/EntryExistsException.cs
@@ -24,6 +24,15 @@ public EntryExistsException(string message)
             : base(message)
         { }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="LibGit2Sharp.EntryExistsException"/> class with a specified error message.
+        /// </summary>
+        /// <param name="format">A composite format string for use in <see cref="String.Format(IFormatProvider, string, object[])"/>.</param>
+        /// <param name="args">An object array that contains zero or more objects to format.</param>
+        public EntryExistsException(string format, params object[] args)
+            : base(format, args)
+        { }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="LibGit2Sharp.EntryExistsException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
         /// </summary>
diff --git a/LibGit2Sharp/InvalidSpecificationException.cs b/LibGit2Sharp/InvalidSpecificationException.cs
@@ -27,6 +27,15 @@ public InvalidSpecificationException(string message)
             : base(message)
         { }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="InvalidSpecificationException"/> class with a specified error message.
+        /// </summary>
+        /// <param name="format">A composite format string for use in <see cref="String.Format(IFormatProvider, string, object[])"/>.</param>
+        /// <param name="args">An object array that contains zero or more objects to format.</param>
+        public InvalidSpecificationException(string format, params object[] args)
+            : base(format, args)
+        { }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="InvalidSpecificationException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
         /// </summary>
diff --git a/LibGit2Sharp/LockedFileException.cs b/LibGit2Sharp/LockedFileException.cs
@@ -24,6 +24,15 @@ public LockedFileException(string message)
             : base(message)
         { }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="LibGit2Sharp.LockedFileException"/> class with a specified error message.
+        /// </summary>
+        /// <param name="format">A composite format string for use in <see cref="String.Format(IFormatProvider, string, object[])"/>.</param>
+        /// <param name="args">An object array that contains zero or more objects to format.</param>
+        public LockedFileException(string format, params object[] args)
+            : base(format, args)
+        { }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="LibGit2Sharp.LockedFileException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
         /// </summary>
diff --git a/LibGit2Sharp/MergeFetchHeadNotFoundException.cs b/LibGit2Sharp/MergeFetchHeadNotFoundException.cs
@@ -23,6 +23,15 @@ public MergeFetchHeadNotFoundException(string message)
             : base(message)
         { }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="MergeFetchHeadNotFoundException"/> class with a specified error message.
+        /// </summary>
+        /// <param name="format">A composite format string for use in <see cref="String.Format(IFormatProvider, string, object[])"/>.</param>
+        /// <param name="args">An object array that contains zero or more objects to format.</param>
+        public MergeFetchHeadNotFoundException(string format, params object[] args)
+            : base(format, args)
+        { }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="MergeFetchHeadNotFoundException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
         /// </summary>
diff --git a/LibGit2Sharp/NameConflictException.cs b/LibGit2Sharp/NameConflictException.cs
@@ -24,6 +24,15 @@ public NameConflictException(string message)
             : base(message)
         { }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="NameConflictException"/> class with a specified error message.
+        /// </summary>
+        /// <param name="format">A composite format string for use in <see cref="String.Format(IFormatProvider, string, object[])"/>.</param>
+        /// <param name="args">An object array that contains zero or more objects to format.</param>
+        public NameConflictException(string format, params object[] args)
+            : base(format, args)
+        { }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="NameConflictException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
         /// </summary>
diff --git a/LibGit2Sharp/NonFastForwardException.cs b/LibGit2Sharp/NonFastForwardException.cs
@@ -25,6 +25,15 @@ public NonFastForwardException(string message)
             : base(message)
         { }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="LibGit2Sharp.NonFastForwardException"/> class with a specified error message.
+        /// </summary>
+        /// <param name="format">A composite format string for use in <see cref="String.Format(IFormatProvider, string, object[])"/>.</param>
+        /// <param name="args">An object array that contains zero or more objects to format.</param>
+        public NonFastForwardException(string format, params object[] args)
+            : base(format, args)
+        { }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="LibGit2Sharp.NonFastForwardException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
         /// </summary>
diff --git a/LibGit2Sharp/NotFoundException.cs b/LibGit2Sharp/NotFoundException.cs
@@ -24,6 +24,15 @@ public NotFoundException(string message)
             : base(message)
         { }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="LibGit2Sharp.NotFoundException"/> class with a specified error message.
+        /// </summary>
+        /// <param name="format">A composite format string for use in <see cref="String.Format(IFormatProvider, string, object[])"/>.</param>
+        /// <param name="args">An object array that contains zero or more objects to format.</param>
+        public NotFoundException(string format, params object[] args)
+            : base(format, args)
+        { }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="LibGit2Sharp.NotFoundException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
         /// </summary>
diff --git a/LibGit2Sharp/PeelException.cs b/LibGit2Sharp/PeelException.cs
@@ -25,6 +25,15 @@ public PeelException(string message)
             : base(message)
         { }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="PeelException"/> class with a specified error message.
+        /// </summary>
+        /// <param name="format">A composite format string for use in <see cref="String.Format(IFormatProvider, string, object[])"/>.</param>
+        /// <param name="args">An object array that contains zero or more objects to format.</param>
+        public PeelException(string format, params object[] args)
+            : base(format, args)
+        { }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="PeelException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
         /// </summary>
diff --git a/LibGit2Sharp/ReflogCollection.cs b/LibGit2Sharp/ReflogCollection.cs
@@ -37,8 +37,7 @@ internal ReflogCollection(Repository repo, string canonicalName)
 
             if (!Reference.IsValidName(canonicalName))
             {
-                throw new InvalidSpecificationException(
-                    string.Format(CultureInfo.InvariantCulture, "The given reference name '{0}' is not valid", canonicalName));
+                throw new InvalidSpecificationException("The given reference name '{0}' is not valid", canonicalName);
             }
 
             this.repo = repo;
diff --git a/LibGit2Sharp/RemoveFromIndexException.cs b/LibGit2Sharp/RemoveFromIndexException.cs
@@ -25,7 +25,7 @@ public RemoveFromIndexException(string message)
         { }
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="LibGit2SharpException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
+        /// Initializes a new instance of the <see cref="RemoveFromIndexException"/> class with a specified error message.
         /// </summary>
         /// <param name="format">A composite format string for use in <see cref="String.Format(IFormatProvider, string, object[])"/>.</param>
         /// <param name="args">An object array that contains zero or more objects to format.</param>
diff --git a/LibGit2Sharp/Repository.cs b/LibGit2Sharp/Repository.cs
@@ -1080,11 +1080,9 @@ public Commit Commit(string message, Signature author, Signature committer, Comm
 
                 if (treesame && !amendMergeCommit)
                 {
-                    throw new EmptyCommitException(
-                        options.AmendPreviousCommit ?
-                        String.Format(CultureInfo.InvariantCulture,
-                            "Amending this commit would produce a commit that is identical to its parent (id = {0})", parents[0].Id) :
-                        "No changes; nothing to commit.");
+                    throw (options.AmendPreviousCommit ? 
+                        new EmptyCommitException("Amending this commit would produce a commit that is identical to its parent (id = {0})", parents[0].Id) :
+                        new EmptyCommitException("No changes; nothing to commit."));
                 }
             }
 
@@ -1273,8 +1271,8 @@ public MergeResult MergeFetchedRefs(Signature merger, MergeOptions options)
             if (fetchHeads.Length == 0)
             {
                 var expectedRef = this.Head.UpstreamBranchCanonicalName;
-                throw new MergeFetchHeadNotFoundException(string.Format(CultureInfo.InvariantCulture,
-                    "The current branch is configured to merge with the reference '{0}' from the remote, but this reference was not fetched.", expectedRef));
+                throw new MergeFetchHeadNotFoundException("The current branch is configured to merge with the reference '{0}' from the remote, but this reference was not fetched.", 
+                    expectedRef);
             }
 
             GitAnnotatedCommitHandle[] annotatedCommitHandles = fetchHeads.Select(fetchHead =>
diff --git a/LibGit2Sharp/RepositoryNotFoundException.cs b/LibGit2Sharp/RepositoryNotFoundException.cs
@@ -24,6 +24,15 @@ public RepositoryNotFoundException(string message)
             : base(message)
         { }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="RepositoryNotFoundException"/> class with a specified error message.
+        /// </summary>
+        /// <param name="format">A composite format string for use in <see cref="String.Format(IFormatProvider, string, object[])"/>.</param>
+        /// <param name="args">An object array that contains zero or more objects to format.</param>
+        public RepositoryNotFoundException(string format, params object[] args)
+            : base(format, args)
+        { }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="RepositoryNotFoundException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
         /// </summary>
diff --git a/LibGit2Sharp/SubmoduleCollection.cs b/LibGit2Sharp/SubmoduleCollection.cs
@@ -62,9 +62,8 @@ public virtual void Init(string name, bool overwrite)
             {
                 if (handle == null)
                 {
-                    throw new NotFoundException(string.Format(CultureInfo.InvariantCulture,
-                                                              "Submodule lookup failed for '{0}'.",
-                                                              name));
+                    throw new NotFoundException("Submodule lookup failed for '{0}'.",
+                                                name);
                 }
 
                 Proxy.git_submodule_init(handle, overwrite);
@@ -90,9 +89,8 @@ public virtual void Update(string name, SubmoduleUpdateOptions options)
             {
                 if (handle == null)
                 {
-                    throw new NotFoundException(string.Format(CultureInfo.InvariantCulture,
-                                                              "Submodule lookup failed for '{0}'.",
-                                                              name));
+                    throw new NotFoundException("Submodule lookup failed for '{0}'.",
+                                                              name);
                 }
 
                 using (GitCheckoutOptsWrapper checkoutOptionsWrapper = new GitCheckoutOptsWrapper(options))
diff --git a/LibGit2Sharp/UnmatchedPathException.cs b/LibGit2Sharp/UnmatchedPathException.cs
@@ -23,6 +23,15 @@ public UnmatchedPathException(string message)
             : base(message)
         { }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="UnmatchedPathException"/> class with a specified error message.
+        /// </summary>
+        /// <param name="format">A composite format string for use in <see cref="String.Format(IFormatProvider, string, object[])"/>.</param>
+        /// <param name="args">An object array that contains zero or more objects to format.</param>
+        public UnmatchedPathException(string format, params object[] args)
+            : base(format, args)
+        { }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="UnmatchedPathException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
         /// </summary>
diff --git a/LibGit2Sharp/UnmergedIndexEntriesException.cs b/LibGit2Sharp/UnmergedIndexEntriesException.cs
diff --git a/LibGit2Sharp/UserCanceledException.cs b/LibGit2Sharp/UserCanceledException.cs

Original file line number	Diff line number	Diff line change
`@@ -261,16 +261,14 @@ public static void GitObjectIsNotNull(GitObject gitObject, string identifier)`
`261`	`261`	`return;`
`262`	`262`	`}`
`263`	`263`
`264`		`- var message = string.Format(CultureInfo.InvariantCulture,`
`265`		`- "No valid git object identified by '{0}' exists in the repository.",`
`266`		`- identifier);`
`267`		`-`
	`264`	`+ var messageFormat = "No valid git object identified by '{0}' exists in the repository.";`
	`265`	`+`
`268`	`266`	`if (string.Equals("HEAD", identifier, StringComparison.Ordinal))`
`269`	`267`	`{`
`270`		`- throw new UnbornBranchException(message);`
	`268`	`+ throw new UnbornBranchException(messageFormat, identifier);`
`271`	`269`	`}`
`272`	`270`
`273`		`- throw new NotFoundException(message);`
	`271`	`+ throw new NotFoundException(messageFormat, identifier);`
`274`	`272`	`}`
`275`	`273`	`}`
`276`	`274`	`}`
Original file line number	Diff line number	Diff line change
`@@ -823,8 +823,7 @@ public static void git_filter_register(string name, IntPtr filterPtr, int priori`
`823`	`823`	`int res = NativeMethods.git_filter_register(name, filterPtr, priority);`
`824`	`824`	`if (res == (int)GitErrorCode.Exists)`
`825`	`825`	`{`
`826`		`- var message = String.Format("A filter with the name '{0}' is already registered", name);`
`827`		`- throw new EntryExistsException(message);`
	`826`	`+ throw new EntryExistsException("A filter with the name '{0}' is already registered", name);`
`828`	`827`	`}`
`829`	`828`	`Ensure.ZeroResult(res);`
`830`	`829`	`}`
`@@ -2256,7 +2255,7 @@ public static void git_remote_rename(RepositorySafeHandle repo, string name, str`
`2256`	`2255`
`2257`	`2256`	`if (res == (int)GitErrorCode.NotFound)`
`2258`	`2257`	`{`
`2259`		`- throw new NotFoundException(string.Format("Remote '{0}' does not exist and cannot be renamed.", name));`
	`2258`	`+ throw new NotFoundException("Remote '{0}' does not exist and cannot be renamed.", name);`
`2260`	`2259`	`}`
`2261`	`2260`
`2262`	`2261`	`Ensure.ZeroResult(res);`
`@@ -2404,9 +2403,8 @@ public static RepositorySafeHandle git_repository_open(string path)`
`2404`	`2403`
`2405`	`2404`	`if (res == (int)GitErrorCode.NotFound)`
`2406`	`2405`	`{`
`2407`		`- throw new RepositoryNotFoundException(String.Format(CultureInfo.InvariantCulture,`
`2408`		`- "Path '{0}' doesn't point at a valid Git repository or workdir.",`
`2409`		`- path));`
	`2406`	`+ throw new RepositoryNotFoundException("Path '{0}' doesn't point at a valid Git repository or workdir.",`
	`2407`	`+ path);`
`2410`	`2408`	`}`
`2411`	`2409`
`2412`	`2410`	`Ensure.ZeroResult(res);`
`@@ -2435,9 +2433,8 @@ public static void git_repository_open_ext(string path, RepositoryOpenFlags flag`
`2435`	`2433`
`2436`	`2434`	`if (res == (int)GitErrorCode.NotFound)`
`2437`	`2435`	`{`
`2438`		`- throw new RepositoryNotFoundException(String.Format(CultureInfo.InvariantCulture,`
`2439`		`- "Path '{0}' doesn't point at a valid Git repository or workdir.",`
`2440`		`- path));`
	`2436`	`+ throw new RepositoryNotFoundException("Path '{0}' doesn't point at a valid Git repository or workdir.",`
	`2437`	`+ path);`
`2441`	`2438`	`}`
`2442`	`2439`
`2443`	`2440`	`Ensure.ZeroResult(res);`
`@@ -3076,8 +3073,8 @@ public static void git_transport_register(String prefix, IntPtr transport_cb, In`
`3076`	`3073`
`3077`	`3074`	`if (res == (int)GitErrorCode.Exists)`
`3078`	`3075`	`{`
`3079`		`- throw new EntryExistsException(String.Format("A custom transport for '{0}' is already registered",`
`3080`		`- prefix));`
	`3076`	`+ throw new EntryExistsException("A custom transport for '{0}' is already registered",`
	`3077`	`+ prefix);`
`3081`	`3078`	`}`
`3082`	`3079`
`3083`	`3080`	`Ensure.ZeroResult(res);`