com.helger.commons.collection.impl.ICommonsSet 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.Collections;
import java.util.Set;
import java.util.function.Function;
import java.util.function.Predicate;

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

import com.helger.commons.annotation.CodingStyleguideUnaware;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.lang.ICloneable;

/**
 * A special {@link Set} interface with extended functionality based on
 * {@link ICommonsCollection}.
 *
 * @author Philip Helger
 * @param 
 *        The data type of the elements in the list.
 */
public interface ICommonsSet  extends
                             Set ,
                             ICommonsCollection ,
                             ICloneable >
{
  /**
   * Create a new empty set. Overwrite this if you don't want to use
   * {@link CommonsHashSet}.
   *
   * @return A new empty set. Never null.
   * @param 
   *        Set element type
   */
  @Nonnull
  @ReturnsMutableCopy
  default  ICommonsSet  createInstance ()
  {
    return new CommonsHashSet <> ();
  }

  @Nonnull
  @ReturnsMutableCopy
  default ICommonsSet  getAll (@Nullable final Predicate  aFilter)
  {
    if (aFilter == null)
      return getClone ();

    final ICommonsSet  ret = createInstance ();
    findAll (aFilter, ret::add);
    return ret;
  }

  @Nonnull
  @ReturnsMutableCopy
  default  ICommonsSet  getAllMapped (@Nonnull final Function  aMapper)
  {
    final ICommonsSet  ret = createInstance ();
    findAllMapped (aMapper, ret::add);
    return ret;
  }

  @Nonnull
  @ReturnsMutableCopy
  default  ICommonsSet  getAllMapped (@Nullable final Predicate  aFilter,
                                                        @Nonnull final Function  aMapper)
  {
    final ICommonsSet  ret = createInstance ();
    findAllMapped (aFilter, aMapper, ret::add);
    return ret;
  }

  @Nonnull
  @ReturnsMutableCopy
  default  ICommonsSet  getAllInstanceOf (@Nonnull final Class  aDstClass)
  {
    final ICommonsSet  ret = createInstance ();
    findAllInstanceOf (aDstClass, ret::add);
    return ret;
  }

  /**
   * Replace an existing item in this Set.
   *
   * @param aElement
   *        The new element to be added.
   * @return true if a previous item was removed,
   *         false if this element was simply added.
   */
  default boolean replace (@Nullable final ELEMENTTYPE aElement)
  {
    final boolean bRemoved = remove (aElement);
    add (aElement);
    return bRemoved;
  }

  @Override
  @Nonnull
  @CodingStyleguideUnaware
  default Set  getAsUnmodifiable ()
  {
    return Collections.unmodifiableSet (this);
  }
}