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

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

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

/**
 * A special {@link Vector} implementation based on {@link ICommonsList}.
 *
 * @author Philip Helger
 * @param 
 *        List element type
 */
public class CommonsVector  extends Vector  implements ICommonsList 
{
  public CommonsVector ()
  {}

  public CommonsVector (@Nonnegative final int nInitialCapacity)
  {
    super (nInitialCapacity);
  }

  public CommonsVector (@Nullable final Collection  aCont)
  {
    super (CollectionHelper.getSize (aCont));
    if (aCont != null)
      addAll (aCont);
  }

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

  public  CommonsVector (@Nullable final Collection  aValues,
                                  @Nonnull final Function  aMapper)
  {
    super (CollectionHelper.getSize (aValues));
    addAllMapped (aValues, aMapper);
  }

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

  public CommonsVector (@Nullable final ELEMENTTYPE aValue)
  {
    super (1);
    add (aValue);
  }

  @SafeVarargs
  public CommonsVector (@Nullable final ELEMENTTYPE... aValues)
  {
    super (ArrayHelper.getSize (aValues));
    addAll (aValues);
  }

  public  CommonsVector (@Nullable final SRCTYPE [] aValues,
                                  @Nonnull final Function  aMapper)
  {
    super (ArrayHelper.getSize (aValues));
    addAllMapped (aValues, aMapper);
  }

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

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

  @Nonnull
  @ReturnsMutableCopy
  public static  CommonsVector  createFiltered (@Nullable final Iterable  aValues,
                                                                          @Nullable final Predicate  aFilter)
  {
    final CommonsVector  ret = new CommonsVector <> (CollectionHelper.getSize (aValues));
    ret.addAll (aValues, aFilter);
    return ret;
  }

  @Nonnull
  @ReturnsMutableCopy
  public static  CommonsVector  createFiltered (@Nullable final Iterable  aValues,
                                                                                   @Nullable final Predicate  aFilter,
                                                                                   @Nonnull final Function  aMapper)
  {
    final CommonsVector  ret = new CommonsVector <> (CollectionHelper.getSize (aValues));
    ret.addAllMapped (aValues, aFilter, aMapper);
    return ret;
  }

  @Nonnull
  @ReturnsMutableCopy
  public static  CommonsVector  createFiltered (@Nullable final ELEMENTTYPE [] aValues,
                                                                          @Nullable final Predicate  aFilter)
  {
    final CommonsVector  ret = new CommonsVector <> (ArrayHelper.getSize (aValues));
    ret.addAll (aValues, aFilter);
    return ret;
  }

  @Nonnull
  @ReturnsMutableCopy
  public static  CommonsVector  createFiltered (@Nullable final SRCTYPE [] aValues,
                                                                                   @Nullable final Predicate  aFilter,
                                                                                   @Nonnull final Function  aMapper)
  {
    final CommonsVector  ret = new CommonsVector <> (ArrayHelper.getSize (aValues));
    ret.addAllMapped (aValues, aFilter, aMapper);
    return ret;
  }
}