Dictionary.java

package xapi.collect.api;

import xapi.fu.In1;
import xapi.fu.In1Out1;
import xapi.fu.In2;
import xapi.util.api.ReceivesValue;

/**
 * A simple dictionary interface, that avoids overwriting java.util.Map
 * interface methods, and can bind to whatever native construct
 * best supports an Object-to-Object mapping. JSOs in javascript, HashMap in jre
 *
 * Note that JSO support requires a key-transformer for everything but String;
 * if you want maximum runtime performance, use {@link xapi.gwt.collect.StringToGwt},
 * or {@link xapi.collect.X_Collect::newStringDictionary()}
 *
 * @author "James X. Nelson (james@wetheinter.net)"
 *
 * @param <K> -
 * @param <V>
 */
public interface Dictionary <K, V> {

  boolean hasKey(K key);

  V getValue(K key);

  V setValue(K key, V value);

  V removeValue(K key);

  void clearValues();

  void forKeys(ReceivesValue<K> receiver);

  default void forEach(In2<K, V> in) {
    forKeys(in.adapt2(this::getValue)::in);
  }
}