EventLog.cs

using CodeName.Serialization.Validation;
using JetBrains.Annotations;
using Newtonsoft.Json;

namespace CodeName.EventEngine
{
    [ValidateSerializeByValue]
    public class EventLog<TGameState>
    {
        [JsonConstructor]
        private EventLog() {}

        /// <summary>
        /// Creates a new event log.
        /// </summary>
        /// <remarks>
        /// Parameters are not cloned.
        /// </remarks>
        public EventLog(GameEventNode<TGameState> events, TGameState originalState = default, TGameState expectedState = default)
        {
            OriginalState = originalState;
            ExpectedState = expectedState;

            Events = events;
        }

        /// <summary>
        /// The events that occurred.
        /// </summary>
        [NotNull]
        [SerializeByValue] public GameEventNode<TGameState> Events { get; set; }

        /// <summary>
        /// The original state prior to applying the <see cref="Events"/>.
        /// Applying the <see cref="Events"/> to the <see cref="OriginalState"/> should result in the <see cref="ExpectedState"/>, if it is available.
        /// </summary>
        /// <remarks>
        /// It is up to the user to decide whether to provide this value or not.
        /// </remarks>
        [CanBeNull]
        [SerializeByValue] public TGameState OriginalState { get; set; }

        /// <summary>
        /// The expected state after applying the <see cref="Events"/>.
        /// </summary>
        /// <remarks>
        /// It is up to the user to decide whether to provide this value or not.
        /// </remarks>
        [CanBeNull]
        [SerializeByValue] public TGameState ExpectedState { get; set; }

        /// <summary>
        /// Creates a new event log using the values of this log.
        /// </summary>
        /// <remarks>
        /// Values are not cloned.
        /// </remarks>
        public EventLog<TGameState> ShallowClone()
        {
            return new EventLog<TGameState>(Events, OriginalState, ExpectedState);
        }
    }
}