80 lines
3.1 KiB
C#
80 lines
3.1 KiB
C#
using OliverBooth.Common.Data.Web;
|
|
|
|
namespace OliverBooth.Data.Web;
|
|
|
|
/// <summary>
|
|
/// Represents a MediaWiki-style template.
|
|
/// </summary>
|
|
public sealed class Template : ITemplate, IEquatable<Template>
|
|
{
|
|
/// <inheritdoc />
|
|
public string FormatString { get; internal set; } = string.Empty;
|
|
|
|
/// <inheritdoc />
|
|
public string Name { get; private set; } = string.Empty;
|
|
|
|
/// <inheritdoc />
|
|
public string Variant { get; private set; } = string.Empty;
|
|
|
|
/// <summary>
|
|
/// Returns a value indicating whether two instances of <see cref="Template" /> are equal.
|
|
/// </summary>
|
|
/// <param name="left">The first instance of <see cref="Template" /> to compare.</param>
|
|
/// <param name="right">The second instance of <see cref="Template" /> to compare.</param>
|
|
/// <returns>
|
|
/// <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are equal; otherwise,
|
|
/// <see langword="false" />.
|
|
/// </returns>
|
|
public static bool operator ==(Template? left, Template? right) => Equals(left, right);
|
|
|
|
/// <summary>
|
|
/// Returns a value indicating whether two instances of <see cref="Template" /> are not equal.
|
|
/// </summary>
|
|
/// <param name="left">The first instance of <see cref="Template" /> to compare.</param>
|
|
/// <param name="right">The second instance of <see cref="Template" /> to compare.</param>
|
|
/// <returns>
|
|
/// <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are not equal; otherwise,
|
|
/// <see langword="false" />.
|
|
/// </returns>
|
|
public static bool operator !=(Template? left, Template? right) => !(left == right);
|
|
|
|
/// <summary>
|
|
/// Returns a value indicating whether this instance of <see cref="Template" /> is equal to another
|
|
/// instance.
|
|
/// </summary>
|
|
/// <param name="other">An instance to compare with this instance.</param>
|
|
/// <returns>
|
|
/// <see langword="true" /> if <paramref name="other" /> is equal to this instance; otherwise,
|
|
/// <see langword="false" />.
|
|
/// </returns>
|
|
public bool Equals(Template? other)
|
|
{
|
|
if (ReferenceEquals(null, other)) return false;
|
|
if (ReferenceEquals(this, other)) return true;
|
|
return Name == other.Name && Variant == other.Variant;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns a value indicating whether this instance is equal to a specified object.
|
|
/// </summary>
|
|
/// <param name="obj">An object to compare with this instance.</param>
|
|
/// <returns>
|
|
/// <see langword="true" /> if <paramref name="obj" /> is an instance of <see cref="Template" /> and
|
|
/// equals the value of this instance; otherwise, <see langword="false" />.
|
|
/// </returns>
|
|
public override bool Equals(object? obj)
|
|
{
|
|
return ReferenceEquals(this, obj) || obj is Template other && Equals(other);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the hash code for this instance.
|
|
/// </summary>
|
|
/// <returns>The hash code.</returns>
|
|
public override int GetHashCode()
|
|
{
|
|
// ReSharper disable NonReadonlyMemberInGetHashCode
|
|
return HashCode.Combine(Name, Variant);
|
|
}
|
|
}
|