com.phloc.commons.collections.multimap.AbstractMultiConcurrentHashMapListBased Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of phloc-commons Show documentation

phloc very basic stuff

There is a newer version: 5.0.0

/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[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.phloc.commons.collections.multimap;

import java.util.List;
import java.util.Map;

import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.ThreadSafe;

import com.phloc.commons.state.EChange;

/**
 * Abstract multi map based on {@link java.util.concurrent.ConcurrentHashMap}
 * and {@link java.util.List} values.

 * Important note: null keys are not allowed here!
 * 
 * @author Philip Helger
 * @param 
 *        key type
 * @param 
 *        value type
 */
@ThreadSafe
public abstract class AbstractMultiConcurrentHashMapListBased  extends AbstractMultiConcurrentHashMap > implements IMultiMapListBased 
{
  public AbstractMultiConcurrentHashMapListBased ()
  {}

  public AbstractMultiConcurrentHashMapListBased (@Nonnull final KEYTYPE aKey, @Nullable final VALUETYPE aValue)
  {
    super (aKey, aValue);
  }

  public AbstractMultiConcurrentHashMapListBased (@Nonnull final KEYTYPE aKey,
                                                  @Nonnull final List  aCollection)
  {
    super (aKey, aCollection);
  }

  public AbstractMultiConcurrentHashMapListBased (@Nullable final Map > aCont)
  {
    super (aCont);
  }

  @Nonnull
  public final EChange putSingle (@Nonnull final KEYTYPE aKey,
                                  @Nullable final VALUETYPE aValue,
                                  @Nonnegative final int nIndex)
  {
    getOrCreate (aKey).add (nIndex, aValue);
    return EChange.UNCHANGED;
  }
}