package org.infinispan.util;

import java.util.Collection;
import java.util.Set;
import java.util.function.Function;

import org.infinispan.commons.util.DistinctFunction;

/**
 * A set that maps another one to a new one of a possibly different type.  Note this set is read only
 * and doesn't accept write operations.
 * <p>
 * This class currently only accepts a {@link Function} that also implements {@link DistinctFunction} so that it can
 * guarantee the resulting mapped values are distinct from each other.  This is important as many operations because
 * very costly if this is not true.
 * <p>
 * Some operations such as {@link Collection#contains(Object)} and {@link Collection#containsAll(Collection)} may be
 * more expensive then normal since they cannot utilize lookups into the original collection.
 * @author wburns
 * @since 8.3
 */
public class SetMapper<E, R> extends CollectionMapper<E, R> {
   public SetMapper(Set<E> realCollection, Function<? super E, ? extends R> mapper) {
      super(realCollection, mapper);
      if (!(mapper instanceof DistinctFunction)) {
         throw new IllegalArgumentException("Function must also provided distinct values as evidented by implementing" +
                 "the marker interface DistinctFunction");
      }
   }
}
