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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation
Java 1.8+ Library with tons of utility classes required in all projects
The newest version!
/*
 * Copyright (C) 2014-2024 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.Collection;
import java.util.Comparator;
import java.util.Map;
import java.util.TreeMap;
import java.util.function.Function;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.annotation.ReturnsMutableCopy;

/**
 * A special {@link TreeMap} implementation based on
 * {@link ICommonsNavigableMap}.
 *
 * @author Philip Helger
 * @param 
 *        Map key type
 * @param 
 *        Map value type
 */
public class CommonsTreeMap  extends TreeMap  implements
                            ICommonsNavigableMap 
{
  public CommonsTreeMap ()
  {}

  public CommonsTreeMap (@Nullable final Comparator  aComparator)
  {
    super (aComparator);
  }

  public CommonsTreeMap (@Nullable final Map  aMap)
  {
    if (aMap != null)
      putAll (aMap);
  }

  public  CommonsTreeMap (@Nullable final COLLTYPE [] aValues,
                                    @Nonnull final Function  aKeyMapper,
                                    @Nonnull final Function  aValueMapper)
  {
    putAllMapped (aValues, aKeyMapper, aValueMapper);
  }

  public  CommonsTreeMap (@Nullable final Collection  aValues,
                                    @Nonnull final Function  aKeyMapper,
                                    @Nonnull final Function  aValueMapper)
  {
    putAllMapped (aValues, aKeyMapper, aValueMapper);
  }

  public  CommonsTreeMap (@Nullable final Map  aValues,
                                                    @Nonnull final Function  aKeyMapper,
                                                    @Nonnull final Function  aValueMapper)
  {
    putAllMapped (aValues, aKeyMapper, aValueMapper);
  }

  @Override
  @Nonnull
  @ReturnsMutableCopy
  public  CommonsTreeMap  createInstance ()
  {
    return new CommonsTreeMap <> ();
  }

  @Nonnull
  @ReturnsMutableCopy
  public CommonsTreeMap  getClone ()
  {
    final CommonsTreeMap  ret = new CommonsTreeMap <> (comparator ());
    ret.putAll (this);
    return ret;
  }
}