com.helger.commons.collection.impl.CommonsEnumMap Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2014-2023 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.commons.collection.impl;

import java.util.EnumMap;

import javax.annotation.Nonnull;

import com.helger.commons.annotation.ReturnsMutableCopy;

/**
 * A special {@link EnumMap} implementation based on {@link ICommonsMap}.
 *
 * @author Philip Helger
 * @param 
 *        Map key type
 * @param 
 *        Map value type
 */
public class CommonsEnumMap , VALUETYPE> extends EnumMap  implements
                            ICommonsMap 
{
  public CommonsEnumMap (@Nonnull final Class  aKeyClass)
  {
    super (aKeyClass);
  }

  public CommonsEnumMap (@Nonnull final EnumMap  aMap)
  {
    super (aMap);
  }

  // Cannot overwrite createInstance because of the special key type generics
  // constraints

  @Nonnull
  @ReturnsMutableCopy
  public CommonsEnumMap  getClone ()
  {
    return new CommonsEnumMap <> (this);
  }
}