psiprobe.tokenizer.UniqueList Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of psi-probe-core Show documentation

PSI Probe Core - Core logic, data models, and controllers

The newest version!

/*
 * Licensed under the GPL License. You may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 *
 * THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
 * WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */
package psiprobe.tokenizer;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;

/**
 * UniqueList is a successor of java.util.Vector to provide a collection
 * that contains no duplicate elements, more formally such that e1.compareTo(e2) == 0.
 *
 * 
 * The collection is kept ordered whenever elements added or removed and besides uniqueness it is to
 * provide fast element search based again on e1.compareTo(e2) values.
 * 
 *
 * @param  the generic type
 */
public class UniqueList> extends ArrayList {

  /** The Constant serialVersionUID. */
  private static final long serialVersionUID = 1L;

  @Override
  public synchronized boolean add(T obj) {
    return add(obj, null);
  }

  /**
   * Adds the.
   *
   * @param obj the obj
   * @param comp the comp
   *
   * @return true, if successful
   */
  protected synchronized boolean add(T obj, Comparator comp) {
    if (isEmpty()) {
      return super.add(obj);
    }
    int index;
    index = comp == null ? Collections.binarySearch(this, obj)
        : Collections.binarySearch(this, obj, comp);
    if (index < 0) {
      int insertionPoint = -index - 1;
      if (insertionPoint >= size()) {
        super.add(obj);
      } else {
        super.add(insertionPoint, obj);
      }
    }
    return index < 0;
  }

  @Override
  public synchronized void add(int index, T obj) {
    add(obj);
  }

  @Override
  public synchronized boolean addAll(Collection comp) {
    boolean ok = this != comp;
    if (ok) {
      for (T compItem : comp) {
        ok &= this.add(compItem);
      }
    }
    return ok;
  }

}