net.objectlab.kit.collections.MapBuilder Maven / Gradle / Ivy

Go to download

/**
 *
 */
package net.objectlab.kit.collections;

import java.util.Map;

/**
 * Inspired by the Google Collection builder.
 *
 * @author Benoit Xhenseval
 *
 */
public interface MapBuilder {
    String getId();

    /**
     * Associates {@code key} with {@code value} in the built map.
     * @param key key
     * @param value value
     * @return a map builder
     */
    MapBuilder put(K key, V value);

    /**
     * Associates all of the given map's keys and values in the built map.
     * @throws NullPointerException if any key or value in {@code map} is null
     * @param map Map to add
     * @return a map builder
     */
    MapBuilder putAll(Map map);
}