diff --git a/Sources/Model/Player.cs b/Sources/Model/Player.cs index a4a949e..5837f91 100644 --- a/Sources/Model/Player.cs +++ b/Sources/Model/Player.cs @@ -3,39 +3,33 @@ using System.Xml.Linq; namespace Model { + /// + /// A player for the purpose of a game of dice, consists of a name + ///
+ /// Two players are equal for Equals() and GetHashCode() if they have the same name, once trimmed and case-insensitive + ///
public sealed class Player : IEquatable { - public string Name + /// + /// a player's unique username + /// + public string Name { get; private set; } //TODO make setter private !!!!!!!!! + public Player(string name) { - get - { - return name; - } - internal set + if (!String.IsNullOrWhiteSpace(name)) { - if (!String.IsNullOrWhiteSpace(value)) - { - name = value.Trim(); - } - else throw new ArgumentException("player name may never be empty or null"); + Name = name.Trim(); } + else throw new ArgumentException("player name may never be empty or null"); } - private string name; - - public Player(string name) - { - Name = name; - } - + /// + /// this is a copy contructor + /// + /// a player object to be copied public Player(Player player) - { - if (player != null) - { - Name = player.name; - } - else throw new ArgumentException("you may not make a copy of a null player"); - } + : this(player?.Name) // passes the player's name if player exists, else null + { } public override string ToString() { @@ -44,7 +38,7 @@ namespace Model 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) @@ -53,12 +47,12 @@ namespace Model { 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() { - return Name.ToUpper().GetHashCode(); + return Name.ToUpper().GetHashCode(); // hash is case insensitive } } }