com.helger.collection.multimap.AbstractMultiHashMapMapBased Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-collection Show documentation

Special Java 1.8+ Library with extended collection related functionality

There is a newer version: 9.5.5

/**
 * Copyright (C) 2014-2020 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed 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.helger.collection.multimap;

import java.util.Map;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;

import com.helger.commons.collection.impl.CommonsHashMap;
import com.helger.commons.collection.impl.ICommonsMap;

/**
 * Abstract multi map based on {@link java.util.HashMap}.
 *
 * @author Philip Helger
 * @param 
 *        outer key type
 * @param 
 *        inner key type
 * @param 
 *        value type
 * @param 
 *        Inner map type
 */
@NotThreadSafe
public abstract class AbstractMultiHashMapMapBased >
                                                   extends
                                                   CommonsHashMap  implements
                                                   IMultiMapMapBased 
{
  public AbstractMultiHashMapMapBased ()
  {}

  public AbstractMultiHashMapMapBased (@Nonnull final KEYTYPE1 aKey,
                                       @Nonnull final KEYTYPE2 aInnerKey,
                                       @Nullable final VALUETYPE aValue)
  {
    putSingle (aKey, aInnerKey, aValue);
  }

  public AbstractMultiHashMapMapBased (@Nullable final KEYTYPE1 aKey,
                                       @Nullable final Map  aValue)
  {
    final MAPTYPE aMap = createNewInnerMap ();
    aMap.putAll (aValue);
    put (aKey, aMap);
  }

  public AbstractMultiHashMapMapBased (@Nullable final Map > aCont)
  {
    if (aCont != null)
      for (final Map.Entry > aEntry : aCont.entrySet ())
      {
        final MAPTYPE aMap = createNewInnerMap ();
        aMap.putAll (aEntry.getValue ());
        put (aEntry.getKey (), aMap);
      }
  }

  @Nonnull
  protected abstract MAPTYPE createNewInnerMap ();

  @Nonnull
  public MAPTYPE getOrCreate (@Nullable final KEYTYPE1 aKey)
  {
    return computeIfAbsent (aKey, k -> createNewInnerMap ());
  }
}