namespace Chernobyl.Utility
{
    /// <summary>
    /// An interface for doing conversions from one type
    /// to another. This can be used in generic code
    /// to allow for conversions that otherwise could
    /// not be done.
    /// </summary>
    public interface IConverter<FirstType, SecondType>
    {
        /// <summary>
        /// Converts the FirstType to the SecondType.
        /// </summary>
        /// <param name="first">The FirstType to convert to the SecondType.</param>
        /// <returns>The converted value.</returns>
        SecondType To(FirstType first);

        /// <summary>
        /// Converts the SecondType to the FirstType.
        /// </summary>
        /// <param name="second">The SecondType to convert to the SecondType.</param>
        /// <returns>The converted value.</returns>
        FirstType From(SecondType second);
    }
}