ObservableDictionaryChangedEventArgs.cs

// <copyright file="ObservableDictionaryChangedEventArgs.cs" company="Michel Weststrate, Jan-Willem Spuij">
// Copyright 2019 Michel Weststrate, Jan-Willem Spuij
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy,
// modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom
// the Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
// WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>

namespace Cortex.Net.Types
{
    using System;
    using System.Collections.Generic;
    using System.Text;

    /// <summary>
    /// Base class for value event args.
    /// </summary>
    /// <typeparam name="TKey">The type of the key that will change.</typeparam>
    /// <typeparam name="TValue">The type of the value that will change.</typeparam>
    public class ObservableDictionaryChangedEventArgs<TKey, TValue> : ObservableDictionaryCancellableEventArgs
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="ObservableDictionaryChangedEventArgs{TKey, TValue}"/> class.
        /// </summary>
        /// <param name="key">They key for this item.</param>
        public ObservableDictionaryChangedEventArgs(TKey key)
        {
            this.Key = key;
        }

        /// <summary>
        /// Gets the key.
        /// </summary>
        public TKey Key { get; private set; }

        /// <summary>
        /// Gets or sets old value.
        /// </summary>
        public TValue OldValue { get; set; }

        /// <summary>
        /// Gets or sets new value.
        /// </summary>
        public TValue NewValue { get; set; }
    }
}