MonoGame.Extended/Source/MonoGame.Extended.NuclexGui/Support/WeakReference.cs

using System;

namespace MonoGame.Extended.NuclexGui.Support
{
    /// <summary>
    ///     Type-safe weak reference, referencing an object while still allowing
    ///     that object to be garbage collected.
    /// </summary>
    public class WeakReference<TReferencedType> : WeakReference
        where TReferencedType : class
    {
        /// <summary>
        ///     Initializes a new instance of the WeakReference class, referencing
        ///     the specified object.
        /// </summary>
        /// <param name="target">The object to track or null.</param>
        public WeakReference(TReferencedType target) :
            base(target)
        {
        }

        /// <summary>
        ///     Initializes a new instance of the WeakReference class, referencing
        ///     the specified object optionally using resurrection tracking.
        /// </summary>
        /// <param name="target">An object to track.</param>
        /// <param name="trackResurrection">
        ///     Indicates when to stop tracking the object. If true, the object is tracked
        ///     after finalization; if false, the object is only tracked until finalization.
        /// </param>
        public WeakReference(TReferencedType target, bool trackResurrection) :
            base(target, trackResurrection)
        {
        }

        /// <summary>
        ///     Initializes a new instance of the WeakReference class, using deserialized
        ///     data from the specified serialization and stream objects.
        /// </summary>
        /// <param name="info">
        ///     An object that holds all the data needed to serialize or deserialize the
        ///     current System.WeakReference object.
        /// </param>
        /// <param name="context">
        ///     (Reserved) Describes the source and destination of the serialized stream
        ///     specified by info.
        /// </param>
        /// <exception cref="System.ArgumentNullException">
        ///     The info parameter is null.
        /// </exception>
        /// <summary>
        ///     Gets or sets the object (the target) referenced by the current WeakReference
        ///     object.
        /// </summary>
        /// <remarks>
        ///     Is null if the object referenced by the current System.WeakReference object
        ///     has been garbage collected; otherwise, a reference to the object referenced
        ///     by the current System.WeakReference object.
        /// </remarks>
        /// <exception cref="System.InvalidOperationException">
        ///     The reference to the target object is invalid. This can occur if the current
        ///     System.WeakReference object has been finalized
        /// </exception>
        public new TReferencedType Target
        {
            get { return base.Target as TReferencedType; }
            set { base.Target = value; }
        }
    }
}