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

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

import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.CollectionHelper;

/**
 * A special ordered {@link Set} based interface with extended functionality
 * based on {@link ICommonsSet}.
 *
 * @author Philip Helger
 * @param 
 *        Set element type
 */
public interface ICommonsOrderedSet  extends ICommonsSet 
{
  @Override
  @Nonnull
  @ReturnsMutableCopy
  default  ICommonsOrderedSet  createInstance ()
  {
    return new CommonsLinkedHashSet <> ();
  }

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

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

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

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

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

  @Nullable
  default ELEMENTTYPE getFirst ()
  {
    return getFirst (null);
  }

  @Nullable
  default ELEMENTTYPE getFirst (@Nullable final ELEMENTTYPE aDefault)
  {
    return isEmpty () ? aDefault : iterator ().next ();
  }

  @Nullable
  default ELEMENTTYPE getLast ()
  {
    return getLast (null);
  }

  @Nullable
  default ELEMENTTYPE getLast (@Nullable final ELEMENTTYPE aDefault)
  {
    return isEmpty () ? aDefault : CollectionHelper.getLastElement (this);
  }

  @Nonnull
  @ReturnsMutableCopy
  ICommonsOrderedSet  getClone ();
}