com.rapiddweller.common.collection.ListBasedSet Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rd-lib-common Show documentation

'rapiddweller Common' is an open source Java library forked from Databene Commons by Volker Bergmann. It provides extensions to the Java core library by utility classes, abstract concepts and concrete implementations.

There is a newer version: 2.0.1-jdk-11

Show newest version

/*
 * Copyright (C) 2004-2015 Volker Bergmann ([email protected]).
 * All rights reserved.
 *
 * 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.rapiddweller.common.collection;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Set;

/**
 * Implements a Set based on a List. This provides for ensuring element uniqueness
 * while maintaining the order in which elements were inserted.
 *
 * @param  the type of the collection's elements            Created: 03.08.2007 18:47:13
 */
public class ListBasedSet implements Set {

  private final List list;

  /**
   * Instantiates a new List based set.
   */
  public ListBasedSet() {
    this.list = new ArrayList<>();
  }

  /**
   * Instantiates a new List based set.
   *
   * @param initialCapacity the initial capacity
   */
  public ListBasedSet(int initialCapacity) {
    this.list = new ArrayList<>(initialCapacity);
  }

  /**
   * Instantiates a new List based set.
   *
   * @param collection the collection
   */
  public ListBasedSet(Collection collection) {
    this.list = new ArrayList<>(collection);
  }

  /**
   * Instantiates a new List based set.
   *
   * @param elements the elements
   */
  @SafeVarargs
  public ListBasedSet(E... elements) {
    this.list = new ArrayList<>(elements.length);
    this.list.addAll(Arrays.asList(elements));
  }

  @Override
  public int size() {
    return list.size();
  }

  @Override
  public boolean isEmpty() {
    return (size() == 0);
  }

  @Override
  public boolean contains(Object o) {
    return list.contains(o);
  }

  @Override
  public Iterator iterator() {
    return list.iterator();
  }

  @Override
  public Object[] toArray() {
    return list.toArray();
  }

  @Override
  public  T[] toArray(T[] a) {
    return list.toArray(a);
  }

  @Override
  public boolean add(E o) {
    if (list.contains(o)) {
      return true;
    } else {
      return list.add(o);
    }
  }

  @Override
  public boolean remove(Object o) {
    return list.remove(o);
  }

  @Override
  public boolean containsAll(Collection c) {
    return list.containsAll(c);
  }

  @Override
  public boolean addAll(Collection c) {
    return list.addAll(c);
  }

  @Override
  public boolean retainAll(Collection c) {
    return list.retainAll(c);
  }

  @Override
  public boolean removeAll(Collection c) {
    return list.removeAll(c);
  }

  @Override
  public void clear() {
    list.clear();
  }

  // List interface --------------------------------------------------------------------------------------------------

  /**
   * Get e.
   *
   * @param index the index
   * @return the e
   */
  public E get(int index) {
    return list.get(index);
  }

  @Override
  public String toString() {
    return list.toString();
  }
}