Stumped By HashSet

[Alana Sparx]

I have created a utility class with a Hashset that stores public holidays. The idea is you pass a date to the class, together with a number of days you would like added to this date.
If the date you pass in falls either on the weekend, or on a public holiday, the utility class will move the passed in date to the next 'business' date. It will then add the number of days you want to increment, and again, if the resulting date falls on a weekend / public holiday, the date is advances to the next 'business' date.

I'm using a HashSet to store objects, created in an inner class, where these objects have two properties
an Sql Date object
a Locale object

When I pass a date and locale to the utility class, I create a new instance of the inner class, and use the contains(obj) method of HashSet to check the date. However, contains(obj) insists on returning false!

I have iterated through the HashSet and compared the Dates and Locales of my passed in object to those in the collection, and even where the dates and locales match, contains() still insists on returning false.

I've set today, tomorrow and Monday as public holidays in the hashset. I want to add one day to today's date as my test - I would therefore expect the next business date to be Tuesday, but the Calendar returns the date as tomorrow!

I could get round this by iterating through the HashSet every time and comparing the date & locale, but I'd rather use contains: any idea why it isn't working for me?

The code:

public class PublicHolidayCalendar
{
    private static PublicHolidayCalendar holidayCalendar = null;
    
    private static HashSet publicHolidays;
    
    private PublicHolidayCalendar()
    {
        init();
    }
    
    //temp values
    HolidayByCountry hol_a = null;
    HolidayByCountry hol_b = null;
    HolidayByCountry hol_c = null;
    HolidayByCountry hol_temp = null;
    
    
    /**
     * 
     * @return
     */public static PublicHolidayCalendar getInstance()
    {
        if(holidayCalendar == null)
        {
            holidayCalendar = new PublicHolidayCalendar();
        }
        return holidayCalendar;
    }
    
    /**
     * Dates will ultimately be loaded from DB, 
     * spoof in meantime
     *
     */private void init()
    {
        publicHolidays = new HashSet();
        loadHolidays();
    }
    
    /**
     * Adds the number of days to the passed in date, returning the next business 
     * date.  This business date takes account of weekends and public holidays.
     * @param date
     * @param nmrDays
     * @param locale
     * @return a business date
     */public Date getBusinessDate(Date date, int nmrDays, Locale locale)
    {
        System.out.println("Date to be checked: " + date);
        
        //create calendar and re-set time fields
        Calendar c = Calendar.getInstance();
        c.setTime(date);
        c.clear(Calendar.HOUR);
        c.clear(Calendar.HOUR_OF_DAY);
        c.clear(Calendar.MINUTE);
        c.clear(Calendar.SECOND);
        c.clear(Calendar.MILLISECOND);
        System.out.println("Test Date! : " + c.getTime().getTime());
 
        date = new Date(c.getTime().getTime());
        
        //is passed in date a weekend or public holiday? 
        //If so, increment the number of days
        while(isWeekend(date) || isPublicHoliday(date, locale))
        {
            System.out.println("inc nmr days...");
            nmrDays++;
        }
        
        //c.setTime(date);
        c.add(Calendar.DAY_OF_MONTH, nmrDays);
        
        //is the destination date a weekend / public holiday?
        //increment as appropriate
        date = new Date(c.getTime().getTime());
        int additionalDay = 1;
        while(isWeekend(date) || isPublicHoliday(date, locale))
        {
            System.out.println("inc additional days....");
            c.add(Calendar.DAY_OF_MONTH, additionalDay);
            date = new Date(c.getTime().getTime());
        }
        
        return date;
    }
    
    /**
     * 
     *
     */private void loadHolidays()
    {
        //to do
        Calendar c = Calendar.getInstance();
        c.set(Calendar.DAY_OF_MONTH, 25);
        c.set(Calendar.MONTH, Calendar.MAY);
        c.set(Calendar.YEAR, 2006);
        c.clear(Calendar.HOUR);
        c.clear(Calendar.HOUR_OF_DAY);
        c.clear(Calendar.MINUTE);
        c.clear(Calendar.SECOND);
        c.clear(Calendar.MILLISECOND);
        System.out.println("Test Date 1: " + c.getTime().getTime());
        
        hol_a = new HolidayByCountry(Locale.UK, new Date(c.getTime().getTime()));
        publicHolidays.add(hol_a);
        
        c = null;
        c = Calendar.getInstance();
        c.set(Calendar.DAY_OF_MONTH, 26);
        c.set(Calendar.MONTH, Calendar.MAY);
        c.set(Calendar.YEAR, 2006);
        c.clear(Calendar.HOUR);
        c.clear(Calendar.HOUR_OF_DAY);
        c.clear(Calendar.MINUTE);
        c.clear(Calendar.SECOND);
        c.clear(Calendar.MILLISECOND);
        System.out.println("Test Date 2: " + c.getTime().getTime());
 
        hol_b = new HolidayByCountry(Locale.UK, new Date(c.getTime().getTime()));
        publicHolidays.add(hol_b);
        
        c = null;
        c = Calendar.getInstance();
        c.set(Calendar.DAY_OF_MONTH, 29);
        c.set(Calendar.MONTH, Calendar.MAY);
        c.set(Calendar.YEAR, 2006);
        c.clear(Calendar.HOUR);
        c.clear(Calendar.HOUR_OF_DAY);
        c.clear(Calendar.MINUTE);
        c.clear(Calendar.SECOND);
        c.clear(Calendar.MILLISECOND);
        System.out.println("Test Date 3: " + c.getTime().getTime());
 
        hol_c = new HolidayByCountry(Locale.UK, new Date(c.getTime().getTime()));
        publicHolidays.add(hol_c);
    }
    
    /**
     * Returns true if the day of the supplied date 
     * is a Saturday or Sunday
     * @return
     */private boolean isWeekend(Date date)
    {
        System.out.println("check weekend: " + date);
        boolean isWeekend = false;
        Calendar c = Calendar.getInstance();
        c.setTime(date);
        int day = c.get(Calendar.DAY_OF_WEEK);
        if( (day == Calendar.SATURDAY) || (day == Calendar.SUNDAY) )
        {
            isWeekend = true;
        }
        return isWeekend;
    }
    
    /**
     * Returns true if the Date specified by the local is a public holiday 
     * @return
     */private boolean isPublicHoliday(Date date, Locale locale)
    {
        System.out.println("check publics: " + date);
        boolean isPublicHoliday = false;
        HolidayByCountry possibleHoliday = new HolidayByCountry(locale, date);
        
        System.out.println("poss Hol: " + possibleHoliday.getDate());
        System.out.println("poss Hol: " + possibleHoliday.getLocale());
        
        System.out.println("########");
        System.out.println("Dates in HashMap");
        Iterator iter = publicHolidays.iterator();
        while(iter.hasNext())
        {
            HolidayByCountry hol = (HolidayByCountry)iter.next();
            System.out.println("Hol date: " + hol.getDate());
            System.out.println("Hol locl: " + hol.getLocale());
            if(possibleHoliday.getDate().equals(hol.getDate()))
            {
                System.out.println("Dates match - " + hol.getDate());
                System.out.println("Dates match - " + possibleHoliday.getDate());
            }
            if(possibleHoliday.getLocale().equals(hol.getLocale()))
            {
                System.out.println("Locales match - " + hol.getLocale().toString());
                System.out.println("Locales match - " + possibleHoliday.getLocale().toString());
            }
            if(! publicHolidays.contains(possibleHoliday))
            {
                System.out.println("Obj not in set:");
                System.out.println("Hol Dates not match  - " + hol.getDate());
                System.out.println("Poss Dates not match - " + possibleHoliday.getDate());
                System.out.println("Hol Locale no match  - " + hol.getLocale().toString());
                System.out.println("Poss Locale no match - " + possibleHoliday.getLocale().toString());
            }
 
        }
        System.out.println("########");
        
        if(publicHolidays.contains(possibleHoliday))
        {
            isPublicHoliday = true;
        }
        
        return isPublicHoliday;
    }
    
    /**
     * Private inner class stores public holidays by country.
     *
     * To change the template for this generated type comment go to
     * Window>Preferences>Java>Code Generation>Code and Comments
     */private class HolidayByCountry
    {
        private Locale locale;
        private Date date;
 
protected  HolidayByCountry(Locale locale, Date date)
        {
            this.locale = locale;
            this.date = date;
        }

protected Locale getLocale()
{
return locale;
}
 
protected Date getDate()
{
return date;
}
    }
}
 

Test Class

    {
        PublicHolidayCalendar bc = PublicHolidayCalendar.getInstance();
        
        Date d = bc.getBusinessDate(new Date(System.currentTimeMillis()), 1, Locale.UK);
        System.out.println("Date: " + d);
    }

Output:
Test Date 1: 1148511600000
Test Date 2: 1148598000000
Test Date 3: 1148857200000
Date to be checked: 2006-05-25
Test Date! : 1148511600000
check weekend: 2006-05-25
check publics: 2006-05-25
poss Hol: 2006-05-25
poss Hol: en_GB
########
Dates in HashMap
Hol date: 2006-05-26
Hol locl: en_GB
Locales match - en_GB
Locales match - en_GB
Obj not in set:
Hol Dates not match - 2006-05-26
Poss Dates not match - 2006-05-25
Hol Locale no match - en_GB
Poss Locale no match - en_GB
Hol date: 2006-05-29
Hol locl: en_GB
Locales match - en_GB
Locales match - en_GB
Obj not in set:
Hol Dates not match - 2006-05-29
Poss Dates not match - 2006-05-25
Hol Locale no match - en_GB
Poss Locale no match - en_GB
Hol date: 2006-05-25
Hol locl: en_GB
Dates match - 2006-05-25
Dates match - 2006-05-25
Locales match - en_GB
Locales match - en_GB
Obj not in set:
Hol Dates not match - 2006-05-25
Poss Dates not match - 2006-05-25
Hol Locale no match - en_GB
Poss Locale no match - en_GB
########
check weekend: 2006-05-26
check publics: 2006-05-26
poss Hol: 2006-05-26
poss Hol: en_GB
########
Dates in HashMap
Hol date: 2006-05-26
Hol locl: en_GB
Dates match - 2006-05-26
Dates match - 2006-05-26
Locales match - en_GB
Locales match - en_GB
Obj not in set:
Hol Dates not match - 2006-05-26
Poss Dates not match - 2006-05-26
Hol Locale no match - en_GB
Poss Locale no match - en_GB
Hol date: 2006-05-29
Hol locl: en_GB
Locales match - en_GB
Locales match - en_GB
Obj not in set:
Hol Dates not match - 2006-05-29
Poss Dates not match - 2006-05-26
Hol Locale no match - en_GB
Poss Locale no match - en_GB
Hol date: 2006-05-25
Hol locl: en_GB
Locales match - en_GB
Locales match - en_GB
Obj not in set:
Hol Dates not match - 2006-05-25
Poss Dates not match - 2006-05-26
Hol Locale no match - en_GB
Poss Locale no match - en_GB
########
Date: 2006-05-26
[/code]

[Christophe Verré]

I think that you have to override equals() and hashCode() in the HolidayByCountry class. Those are used to retrieve an object from a HashMap

[Mandar Max]

You should override public boolean equals(Object obj) method of Object class and provide an implementation in your inner class. For the method 'contains(Object o)' to work properly the 'equqls(Object o)' method is necessary.

If you look at the description of contains method it says:

boolean contains(Object o)

Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that (o==null ? e==null : o.equals(e)).

[Alana Sparx]

Thank you for your replies chaps.

I've put the following method into the inner class

public boolean equals(Object object)
{
  if(this == object)
    {
      return true;
    }
  System.out.println("Checking equality!");
  boolean isEqual = false;
  if(object instanceof HolidayByCountry)
  {
    HolidayByCountry holiday = (HolidayByCountry)object;
    if((this.getDate().equals(holiday.getDate())) && 
       (this.getLocale().equals(holiday.getLocale())) )
    {
      isEqual = true;
    }
  }
  return isEqual;
}

Sadly, it is making no difference. The system out doesn't print so I suspect the method may not be being called.
If I really have to override HashCode, what on earth do I do?!? i had a look at the String version - scary!

[Mandar Max]

Forgot to tell you one thing - You should also override hashCode method in your inner class. Equal objects should have equal hashCodes.

You can implement a simple hashCode method like this:

public int hashCode() {
    return date.hashCode() + locale.hashCode();
}

Now I am sure, your equals() method will be definitely called and you should be able to use the contains() method as you intended.
[ May 25, 2006: Message edited by: Mandar Max ]

[Alana Sparx]

Ok, I tried an incredibly complex implementation of hashCode():

  public int hashCode()
  {
    return 0;
  }

This surely cannot be all there is to it? The Calendar is now working though, so I'm happy, but somewhat nervous.......

[Alana Sparx]

Tanks all

Mr Max, I took your advice re: implimentation of getHashCode() - just seems to be a tad more robust than my initial pathetic attempt.

Many thanks

The Spark