When implementing IDisposable, I undertand that every method that shouldn't be called after the object's been disposed should throw the ObjectDisposedException
. But what is the standard for the name object that should be passed to the exception's constructor?
3 Answers
I believe the recommended practice is to throw the following:
throw new ObjectDisposedException(GetType().FullName);
Or including the check, these two lines of code at the top of each method that needs it (obviously not the Dispose
method itself):
if (this.disposed)
throw new ObjectDisposedException(GetType().FullName);
Might even be helpful to refactor this into a tiny method for usability.
-
Also, please see this question and my answer for general guidelines: stackoverflow.com/questions/668440/…– NoldorinCommented Dec 26, 2009 at 22:28
Even the .NET Framework itself isn't very consistent here.
David M. Kean (former developer on the FxCop team at Microsoft) added a comment to the MSDN documentation for the ObjectDisposedException:
The typical usage of this type is something like the following:
[C#] private void CheckDisposed() { throw new ObjectDisposedException(GetType().FullName); }
-
I missed it. Mut learn to read the comments in the documentation also.– WilhelmCommented Dec 26, 2009 at 22:42
-
1@JonathonReinhart: The comment was obviously removed from the .NET 4-version of the page. I fixed the link above so it refers to the .NET 3.5-version which includes the quoted comment.– AlbicCommented Jun 30, 2012 at 9:39
-
Might as well do
throw new ObjectDisposedException(ToString());
– ScoverCommented Jun 13, 2023 at 7:46
I don't believe there's a standard for that, I would return the type of the object along with the string content of a unique identifying field (a 'Primary Key' of sorts).