// Copyright (C) Stichting Deltares 2023. All rights reserved.
// 
// This file is part of the Dam Engine.
// 
// The Dam Engine is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
// 
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
// 
// All names, logos, and references to "Deltares" are registered trademarks of
// Stichting Deltares and remain full property of Stichting Deltares at all times.
// All rights reserved.

namespace Deltares.DamEngine.Data.Standard.Logging;

/// <summary>
/// Class for logmessages
/// </summary>
public class LogMessage
{
    /// <summary>
    /// Initializes a new instance of the <see cref="LogMessage"/> class.
    /// </summary>
    public LogMessage() {}

    /// <summary>
    /// Initializes a new instance of the <see cref="LogMessage"/> class.
    /// </summary>
    /// <param name="messageType">Type of the message.</param>
    /// <param name="subject">The subject.</param>
    /// <param name="message">The message.</param>
    public LogMessage(LogMessageType messageType, object subject, string message)
    {
        this.MessageType = messageType;
        Subject = subject;
        this.Message = message;
    }

    /// <summary>
    /// Gets or sets the type of the message.
    /// </summary>
    /// <value>
    /// The type of the message.
    /// </value>
    public LogMessageType MessageType { get; set; } = LogMessageType.Info;

    /// <summary>
    /// Gets or sets the subject.
    /// </summary>
    /// <value>
    /// The subject.
    /// </value>
    public object Subject { get; set; }

    /// <summary>
    /// Gets or sets the message.
    /// </summary>
    /// <value>
    /// The message.
    /// </value>
    public string Message { get; set; } = "";

    /// <summary>
    /// Returns a <see cref="System.String" /> that represents this instance.
    /// </summary>
    /// <returns>
    /// A <see cref="System.String" /> that represents this instance.
    /// </returns>
    public override string ToString()
    {
        return Message;
    }
}