How HashSet works in java

HashSet:

HashSet implements Set interface which does not allow duplicate value.It is not synchronized and is not thread safe.
Definition of duplicate can be quite tricky sometimes.Lets consider two cases here.

1. In case of primitive types(such as interger, String)
2. In case of custom defined objects.

In case of primitive types:

In case of primitives type, it is very straight forward.Lets see with help of example:

Lets create a java program:

view plainprint?

1. package org.arpit.java2blog;
2. import java.util.HashSet;
4. public class HashSetMain {
6.  public static void main(String[] args) {
7.   HashSet<String> nameSet=new HashSet<String>();
8.   nameSet.add(“Arpit”);
9.   nameSet.add(“Arpit”);
10.   nameSet.add(“john”);
11.   System.out.println(“size of nameSet=”+nameSet.size());
12.   System.out.println(nameSet);
13.  }
15. }

When you run above program, you will get following output:

view plainprint?

1. size of nameSet=2
2. [Arpit, john]

So we tried to add String “Arpit” twice, but as HashSet does not allow duplicate value, it will add “Arpit” once in HashSet
In case of Custom Objects:
For understanding how HashSet will work in case of custom objects, you need to understand hashcode and equals method in java.Lets create a class called Country and implement only equals method in it.

view plainprint?

1. package org.arpit.java2blog;
3. public class Country {
5.  String name;
6.  long population;
7.  public String getName() {
8.   return name;
9.   }
10.  public void setName(String name){
11.   this.name = name;
12.  }
13.  public long getPopulation() {
14.   return population;
15.  }
16.  public void setPopulation(long population) {
17.   this.population = population;
18.  }
20.  public String toString()
21.  {
22.   return name;
23.  }
24.  @Override
25.  public boolean equals(Object obj) {
26.   if (this == obj)
27.    return true;
28.   if (obj == null)
29.    return false;
30.   if (getClass() != obj.getClass())
31.    return false;
32.   Country other = (Country) obj;
33.   if (name == null) {
34.    if (other.name != null)
35.     return false;
36.   } else if (!name.equals(other.name))
37.    return false;
38.   return true;
39.  }
41. }

create main class:

view plainprint?

1. package org.arpit.java2blog;
3. import java.util.HashSet;
5. public class HashSetCountryMain {
7.  public static void main(String[] args)
8.  {
9.   HashSet<Country> countrySet=new HashSet<Country>();
10.   Country india1=new Country();
11.   india1.setName(“India”);
13.   Country india2=new Country();
14.   india2.setName(“India”);
16.   countrySet.add(india1);
17.   countrySet.add(india2);
19.   System.out.println(“size of nameSet=”+countrySet.size());
20.   System.out.println(countrySet);
22.  }
23. }

When you run above program, you will get following output:

view plainprint?

1. size of nameSet=2
2. [India, India]

Now you must be wondering even through two objects are equal why HashSet contains two values instead of one.This is because First HashSet calculates hashcode for that key object, if hashcodes are same then only it checks for equals method and because hashcode for above two country objects uses default hashcode method,Both will have different memory address hence different hashcode.
Now lets add hashcode method in above Country class

view plainprint?

1. @Override
2.  public int hashCode() {
3.   final int prime = 31;
4.   int result = 1;
5.   result = prime * result + ((name == null) ? 0 : name.hashCode());
6.   return result;
7.  }

Run above main program again, you will get following output:

view plainprint?

1. size of nameSet=1
2. [India]

So now we have good understanding of HashSet, lets see its internal representation:

Internal working of HashSet:

When you add any duplicate element to HashSet, add() method returns false and do not add duplicate element to HashSet.

How add method return false? For this, we need to see HashSet’s add method in JavaAPI

view plainprint?

1. public class HashSet<E>
2.     extends AbstractSet<E>
3.     implements Set<E>, Cloneable, java.io.Serializable
4. {
6.     private transient HashMap<E,Object> map;
8.     // PRESENT is dummy value which will be used as value in map
9.     private static final Object PRESENT = new Object();
11.     /**
12.      * Constructs a empty map.so hash
13.      * 
14.      */
15.     public HashSet() {
16.         map = new HashMap<E,Object>();
17.     }
19.     // return false if e is already present in HashSet
20.     public boolean add(E e) {
21.         return map.put(e, PRESENT)==null;
22.     }
24.     // other HashSet methods
25. }

So from above code, It is clear that HashSet uses HashMap for checking duplicate elements.As we know that in HashMap , key should be unique. So HashSet uses this concept, When element is added to HashSet, it is added to internal HashMap as Key.This HashMap required some value so a dummy Object(PRESENT) is used as value in this HashMap.
PRESENT is dummy value which is used value for internal map.
Lets see add method:

view plainprint?

1. // return false if e is already present in HashSet
2.    public boolean add(E e) {
3.     return map.put(e, PRESENT)==null;
4.    }

So here there will be two cases

• map.put(e,PRESENT) will return null, if element not present in that map. So map.put(e, PRESENT) == null will return true ,hence add method will return true and element will be added in HashSet.
• map.put(e,PRESENT) will return old value ,if element is already present in that map. So  map.put(e, PRESENT) == null will return false, hence add method will return false and element will not be added in HashSet.

For more Visit: http://www.quontrasolutions.com/blog/category/java