DisposableBase 1.0.3

DisposableBase

A simple base class for disposable objects.

Usage

This library provides a base class DisposableBase for classes that need to implement the IDisposable Interface.

namespace System
{
    public abstract class DisposableBase : IDisposable
    {
        ~DisposableBase()
        {
            Dispose(false);
        }

        public void Dispose()
        {
            Dispose(true);
            GC.SuppressFinalize(this);
        }

        private void Dispose(bool disposing)
        {
            if (!disposed_)
            {
                if (disposing)
                {
                    DisposeManaged();
                }

                DisposeUnmanaged();

                disposed_ = true;
            }
        }

        protected virtual void DisposeManaged()
        {
        }

        protected virtual void DisposeUnmanaged()
        {
        }

        protected void ThrowIfDisposed()
        {
            if (disposed_)
                throw new ObjectDisposedException(string.Format("{0} object is disposed.", GetType().Name));
        }

        protected bool disposed_ = false;
    }
}

As shown above, DisposableBase provides two virtual methods, DisposeManaged and DisposeUnmanaged, to clean up managed and unmanaged resources respectively. You can override one or both of these methods as needed.

The ThrowIfDisposed method checks whether the current object has been disposed, and if so, throws an exception.

Known Issues

1. Given that C# does not support multiple inheritance of classes, if your class already includes a base class, it may not be possible to inherit from DisposableBase. In such a case, you can use DisposableBase as a reference to implement the IDisposable Interface on your own.
2. (Feedback is welcome.)

Related Projects

• Disposables
• Dispose.Scope
• IDisposableAnalyzers
• Open.Disposable

License

MIT