State.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace interweb.CalendarCalculator
{
    /******************************************************************************************************************
     * This class holds states/province of a country for holiday-assignment
     * 
     * Methods GetHashCode and Equals are overwritten, because this class is used for a dictionary key as well.
     * This is not usual, but it works perfectly. The key id for the dictionary is the state id and an exception
     * is thrown, when you try to add a state (ID) to the dictionary list twice.
     * 
     * Last update: 15.05.2010
     ******************************************************************************************************************/
    //-----------------------------------------------------------------------------------------------------------------
    public class State : IEquatable<State>
    //-----------------------------------------------------------------------------------------------------------------
    {
        int _stateID;                                           // e. g. 2
        string _stateName;                                      // e. g. "Bavaria"

        //-----------------------------------------------------------------------------------------------------------------
        public State(int stateID, string stateName)
        //-----------------------------------------------------------------------------------------------------------------
        {
            this._stateID = stateID;
            this._stateName = stateName;
        }

        //-----------------------------------------------------------------------------------------------------------------
        public int StateID
        //-----------------------------------------------------------------------------------------------------------------
        {
            get { return this._stateID; }
        }

        //-----------------------------------------------------------------------------------------------------------------
        public string StateName
        //-----------------------------------------------------------------------------------------------------------------
        {
            get { return this._stateName; }
        }

        //-----------------------------------------------------------------------------------------------------------------
        public override int GetHashCode()
        //-----------------------------------------------------------------------------------------------------------------
        {
            return( this.StateID );
        }

        //-----------------------------------------------------------------------------------------------------------------
        public override bool Equals(object obj)
        //-----------------------------------------------------------------------------------------------------------------
        {
            return( Equals(obj as State) );
        }

        //-----------------------------------------------------------------------------------------------------------------
        public bool Equals(State obj)
        //-----------------------------------------------------------------------------------------------------------------
        {
            return( obj != null && obj.StateID == this.StateID );
        } 
    }
}