🩹 Move validation to constructor, clarify with comments

pull/52/head
Alexis Drai 3 years ago
parent e85b9e5550
commit fb02307b28

@ -3,39 +3,33 @@ using System.Xml.Linq;
namespace Model namespace Model
{ {
/// <summary>
/// A player for the purpose of a game of dice, consists of a name
/// <br/>
/// Two players are equal for Equals() and GetHashCode() if they have the same name, once trimmed and case-insensitive
/// </summary>
public sealed class Player : IEquatable<Player> public sealed class Player : IEquatable<Player>
{ {
public string Name /// <summary>
/// a player's unique username
/// </summary>
public string Name { get; private set; } //TODO make setter private !!!!!!!!!
public Player(string name)
{ {
get if (!String.IsNullOrWhiteSpace(name))
{
return name;
}
internal set
{ {
if (!String.IsNullOrWhiteSpace(value)) Name = name.Trim();
{
name = value.Trim();
}
else throw new ArgumentException("player name may never be empty or null");
} }
else throw new ArgumentException("player name may never be empty or null");
} }
private string name; /// <summary>
/// this is a copy contructor
public Player(string name) /// </summary>
{ /// <param name="player">a player object to be copied</param>
Name = name;
}
public Player(Player player) public Player(Player player)
{ : this(player?.Name) // passes the player's name if player exists, else null
if (player != null) { }
{
Name = player.name;
}
else throw new ArgumentException("you may not make a copy of a null player");
}
public override string ToString() public override string ToString()
{ {
@ -44,7 +38,7 @@ namespace Model
public bool Equals(Player other) public bool Equals(Player other)
{ {
return Name.ToUpper() == other.Name.ToUpper(); return Name.ToUpper() == other.Name.ToUpper(); // equality is case insensitive
} }
public override bool Equals(Object obj) public override bool Equals(Object obj)
@ -53,12 +47,12 @@ namespace Model
{ {
return false; return false;
} }
return Equals(obj as Player); return Equals(obj as Player); // casting, to send it to the above Equals() method
} }
public override int GetHashCode() public override int GetHashCode()
{ {
return Name.ToUpper().GetHashCode(); return Name.ToUpper().GetHashCode(); // hash is case insensitive
} }
} }
} }

Loading…
Cancel
Save