net.sf.javagimmicks.collections.builder.MapBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gimmicks Show documentation
Utility classes, APIs and tools for Java
There is a newer version: 0.99-alpha1
package net.sf.javagimmicks.collections.builder;

import java.util.Comparator;
import java.util.HashMap;
import java.util.Map;
import java.util.TreeMap;

/**
 * A builder class for building {@link Map}s using a fluent API with one chained
 * call.
 * 
 * @param 
 *           the type of keys the resulting {@link Map} will use
 * @param 
 *           the type of values the resulting {@link Map} will use
 * @param 
 *           the type of the produced {@link Map}
 */
public class MapBuilder>
{
   protected final T _internalMap;

   /**
    * Wraps a new {@link MapBuilder} around the given {@link Map}
    * 
    * @param internalMap
    *           the {@link Map} to wrap a new {@link MapBuilder} around
    * @param 
    *           the type of keys the resulting {@link Map} will use
    * @param 
    *           the type of values the resulting {@link Map} will use
    * @param 
    *           the type of the produced {@link Map}
    * @return the resulting {@link MapBuilder}
    */
   public static > MapBuilder create(final T internalMap)
   {
      return new MapBuilder(internalMap);
   }

   /**
    * Creates a new {@link MapBuilder} for building a new {@link HashMap}
    * 
    * @param 
    *           the type of keys the resulting {@link HashMap} will use
    * @param 
    *           the type of values the resulting {@link HashMap} will use
    * @return the resulting {@link MapBuilder}
    */
   public static  MapBuilder> createHashMap()
   {
      return create(new HashMap());
   }

   /**
    * Creates a new {@link MapBuilder} for building a new {@link TreeMap}
    * 
    * @param 
    *           the type of keys the resulting {@link TreeMap} will use
    * @param 
    *           the type of values the resulting {@link TreeMap} will use
    * @return the resulting {@link MapBuilder}
    */
   public static  MapBuilder> createTreeMap()
   {
      return create(new TreeMap());
   }

   /**
    * Creates a new {@link MapBuilder} for building a new {@link TreeMap} based
    * on the given {@link Comparator}
    * 
    * @param comparator
    *           the {@link Comparator} for the {@link TreeMap} to create
    * @param 
    *           the type of keys the resulting {@link TreeMap} will use
    * @param 
    *           the type of values the resulting {@link TreeMap} will use
    * @return the resulting {@link MapBuilder}
    */
   public static  MapBuilder> createTreeMap(final Comparator comparator)
   {
      return create(new TreeMap(comparator));
   }

   /**
    * Creates a new {@link MapBuilder} around a given internal {@link Map}
    * 
    * @param internalMap
    *           the {@link Map} to wrap around
    */
   public MapBuilder(final T internalMap)
   {
      _internalMap = internalMap;
   }

   /**
    * Calls {@link Map#put(Object, Object)} on the underlying {@link Map} and
    * returns itself
    * 
    * @param key
    *           key with which the specified value is to be associated
    * @param value
    *           value to be associated with the specified key
    * @return the {@link MapBuilder} itself
    * @see Map#put(Object, Object)
    */
   public MapBuilder put(final K key, final V value)
   {
      _internalMap.put(key, value);
      return this;
   }

   /**
    * Calls {@link Map#putAll(Map)} on the underlying {@link Map} and returns
    * itself
    * 
    * @param map
    *           mappings to be stored in this map
    * @return the {@link MapBuilder} itself
    * @see Map#putAll(Map)
    */
   public MapBuilder putAll(final Map map)
   {
      _internalMap.putAll(map);
      return this;
   }

   /**
    * Calls {@link Map#remove(Object)} on the underlying {@link Map} and returns
    * itself
    * 
    * @param key
    *           key whose mapping is to be removed from the map
    * @return the {@link MapBuilder} itself
    * @see Map#remove(Object)
    */
   public MapBuilder remove(final Object key)
   {
      _internalMap.remove(key);
      return this;
   }

   /**
    * Calls {@link Map#clear()} on the underlying {@link Map} and returns itself
    * 
    * @return the {@link MapBuilder} itself
    * @see Map#clear()
    */
   public MapBuilder clear()
   {
      _internalMap.clear();
      return this;
   }

   /**
    * Returns the underlying {@link Map}
    * 
    * @return the underlying {@link Map}
    */
   public T toMap()
   {
      return _internalMap;
   }

   @Override
   public String toString()
   {
      return _internalMap.toString();
   }
}