com.davidbracewell.collection.NormalizedStringMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mango Show documentation
A set of utilities and tools to speed up and ease programming in Java.
There is a newer version: 0.5
/*
 * (c) 2005 David B. Bracewell
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package com.davidbracewell.collection;

import com.davidbracewell.tuple.Tuple2;
import com.google.common.collect.Iterators;
import lombok.EqualsAndHashCode;
import lombok.NonNull;

import java.io.Serializable;
import java.text.CollationKey;
import java.text.Collator;
import java.util.*;

/**
 * A string map that uses a Collator to normalize strings. All Strings are lower-cased when put into the
 * map. Once an item has been put in the map the
 * original case can not be restored. Does not support null key values.
 *
 * @param  The value type
 * @author David B. Bracewell
 */
@EqualsAndHashCode
public class NormalizedStringMap implements Map, Serializable {

  private static final long serialVersionUID = 1930175668438751641L;
  private final Collator collator;
  private final Map map;

  /**
   * Default Constructor uses the default locale for collation
   */
  public NormalizedStringMap() {
    this(Locale.ENGLISH);
  }

  /**
   * Locale initializing constructor. Uses Collator.PRIMARY as the strength
   *
   * @param locale The local to use for collation
   */
  public NormalizedStringMap(Locale locale) {
    this(locale, Collator.PRIMARY);
  }


  /**
   * Locale and strength initializing constructor
   *
   * @param locale   The local to use for collation
   * @param strength the collation strength(e.g. Collator.PRIMARY )
   */
  public NormalizedStringMap(Locale locale, int strength) {
    this.map = new HashMap<>();
    this.collator = Collator.getInstance(locale);
    this.collator.setStrength(strength);
    this.collator.setDecomposition(Collator.CANONICAL_DECOMPOSITION);
  }

  @Override
  public void clear() {
    map.clear();
  }

  private CollationKey collate(Object o) {
    if (o == null || !(o instanceof String)) {
      return null;
    }
    return collator.getCollationKey(o.toString());
  }

  @Override
  public boolean containsKey(Object key) {
    return map.containsKey(collate(key));
  }

  @Override
  public boolean containsValue(Object value) {
    return map.containsValue(value);
  }

  @Override
  public Set> entrySet() {
    return new AbstractSet>() {
      @Override
      public Iterator> iterator() {
        return Iterators.transform(map.entrySet().iterator(), entry -> Tuple2.of(entry.getKey().getSourceString(), entry.getValue()));
      }

      @Override
      public int size() {
        return map.size();
      }
    };
  }

  @Override
  public V get(Object arg0) {
    return map.get(collate(arg0));
  }

  @Override
  public boolean isEmpty() {
    return map.isEmpty();
  }

  @Override
  public Set keySet() {
    return new AbstractSet() {
      @Override
      public Iterator iterator() {
        return Iterators.transform(map.keySet().iterator(), CollationKey::getSourceString);
      }

      @Override
      public int size() {
        return map.size();
      }
    };
  }

  @Override
  public V put(@NonNull String arg0, V arg1) {
    return map.put(collator.getCollationKey(arg0), arg1);
  }

  @Override
  public void putAll(Map m) {
    if (m != null) {
      m.entrySet().forEach(entry -> put(entry.getKey(), entry.getValue()));
    }
  }

  @Override
  public V remove(Object key) {
    return map.remove(collate(key));
  }

  @Override
  public int size() {
    return map.size();
  }

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

  @Override
  public Collection values() {
    return map.values();
  }

}// END OF CaseInsensitiveMap