ICD.Common.Utils/ICD.Common.Utils/Services/Logging/LogItem.cs

#if NETFRAMEWORK
extern alias RealNewtonsoft;
using RealNewtonsoft.Newtonsoft.Json;
using RealNewtonsoft.Newtonsoft.Json.Converters;
#else
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
#endif
using System;

namespace ICD.Common.Utils.Services.Logging
{
	/// <summary>
	/// Log Entry Item
	/// </summary>
	public struct LogItem : IEquatable<LogItem>
	{
		private readonly string m_Message;
		private readonly eSeverity m_Severity;
		private readonly DateTime m_Timestamp;

		#region Properties

		/// <summary>
		/// Gets the log time in UTC.
		/// </summary>
		public DateTime Timestamp { get { return m_Timestamp; } }

		/// <summary>
		/// Get/Set for severity level.
		/// </summary>
		[JsonConverter(typeof(StringEnumConverter))]
		public eSeverity Severity { get { return m_Severity; } }

		/// <summary>
		/// Get/Set for message string.
		/// </summary>
		public string Message { get { return m_Message; } }

		#endregion

		#region Constructors

		/// <summary>
		/// Creates a new LogItem object with the specified values.
		/// </summary>
		/// <param name="severity">Severity Level, between 0 and 7</param>
		/// <param name="message">Error message text</param>
		public LogItem(eSeverity severity, string message)
			: this(IcdEnvironment.GetUtcTime(), severity, message)
		{
		}

		/// <summary>
		/// Creates a new LogItem object with the specified values.
		/// </summary>
		/// <param name="timestamp"></param>
		/// <param name="severity">Severity Level, between 0 and 7</param>
		/// <param name="message">Error message text</param>
		[JsonConstructor]
		public LogItem(DateTime timestamp, eSeverity severity, string message)
		{
			m_Severity = severity;
			m_Message = message;
			m_Timestamp = timestamp;
		}

		#endregion

		#region Methods

		/// <summary>
		/// Implementing default equality.
		/// </summary>
		/// <param name="a1"></param>
		/// <param name="a2"></param>
		/// <returns></returns>
		public static bool operator ==(LogItem a1, LogItem a2)
		{
			return a1.Equals(a2);
		}

		/// <summary>
		/// Implementing default inequality.
		/// </summary>
		/// <param name="a1"></param>
		/// <param name="a2"></param>
		/// <returns></returns>
		public static bool operator !=(LogItem a1, LogItem a2)
		{
			return !a1.Equals(a2);
		}

		/// <summary>
		/// Returns true if this instance is equal to the given object.
		/// </summary>
		/// <param name="other"></param>
		/// <returns></returns>
		public bool Equals(LogItem other)
		{
			return m_Severity == other.m_Severity &&
			       m_Timestamp == other.m_Timestamp &&
			       m_Message == other.m_Message;
		}

		/// <summary>
		/// Returns true if this instance is equal to the given object.
		/// </summary>
		/// <param name="other"></param>
		/// <returns></returns>
		public override bool Equals(object other)
		{
			return other is LogItem && Equals((LogItem)other);
		}

		/// <summary>
		/// Gets the hashcode for this instance.
		/// </summary>
		/// <returns></returns>
		public override int GetHashCode()
		{
			unchecked
			{
				int hash = 17;
				hash = hash * 23 + (m_Message == null ? 0 : m_Message.GetHashCode());
				hash = hash * 23 + (int)m_Timestamp.Ticks;
				hash = hash * 23 + (int)m_Severity;
				return hash;
			}
		}

		#endregion
	}
}