com.helger.commons.collection.impl.CommonsTreeSet 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

There is a newer version: 11.1.10

/*
 * 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.TreeSet;
import java.util.function.Function;

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

import com.helger.commons.annotation.ReturnsMutableCopy;

/**
 * A special {@link TreeSet} implementation based on
 * {@link ICommonsNavigableSet}.
 *
 * @author Philip Helger
 * @param 
 *        Set element type
 */
public class CommonsTreeSet  extends TreeSet  implements ICommonsNavigableSet 
{
  public CommonsTreeSet ()
  {}

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

  public CommonsTreeSet (@Nullable final Collection  aCont)
  {
    if (aCont != null)
      addAll (aCont);
  }

  public CommonsTreeSet (@Nullable final Iterable  aIterable)
  {
    addAll (aIterable);
  }

  public  CommonsTreeSet (@Nullable final Iterable  aValues,
                                   @Nonnull final Function  aMapper)
  {
    addAllMapped (aValues, aMapper);
  }

  public CommonsTreeSet (@Nullable final ELEMENTTYPE aValue)
  {
    add (aValue);
  }

  @SafeVarargs
  public CommonsTreeSet (@Nullable final ELEMENTTYPE... aValues)
  {
    addAll (aValues);
  }

  public  CommonsTreeSet (@Nullable final SRCTYPE [] aValues,
                                   @Nonnull final Function  aMapper)
  {
    addAllMapped (aValues, aMapper);
  }

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

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