com.hfg.util.collection.OrderedSet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.util.collection;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Set;

//------------------------------------------------------------------------------
/**
 * Set that preserves the addition order.
 * @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public class OrderedSet extends ArrayList implements Set
{
   //##########################################################################
   // CONSTRUCTORS
   //##########################################################################

   //--------------------------------------------------------------------------
   public OrderedSet()
   {
      super();
   }

   //--------------------------------------------------------------------------
   public OrderedSet(int inInitialCapacity)
   {
      super(inInitialCapacity);
   }

   //--------------------------------------------------------------------------
   public OrderedSet(Collection  inValues)
   {
      super(inValues != null ? inValues.size() : 99);
      addAll(inValues);
   }

   //##########################################################################
   // PUBLIC METHODS
   //##########################################################################


   //--------------------------------------------------------------------------
   public boolean add(E inObj)
   {
      boolean result = false;

      if (! contains(inObj))
      {
         super.add(inObj);
         result = true;
      }

      return result;
   }

   //--------------------------------------------------------------------------
   public void add(int inIndex, E inObj)
   {
      if (! contains(inObj))
      {
         super.add(inIndex, inObj);
      }
   }

   //--------------------------------------------------------------------------
   public boolean addAll(Collection  inCollection)
   {
      boolean changed = false;
      if (CollectionUtil.hasValues(inCollection))
      {
         for (E value : inCollection)
         {
            if (add(value)) changed = true;
         }
      }

      return changed;
   }

   //--------------------------------------------------------------------------
   @Override
   public boolean addAll(int inIndex, Collection inCollection)
   {
      boolean changed = false;
      for (E value : inCollection)
      {
         changed = ! contains(value);
         add(inIndex++, value);
      }

      return changed;
   }

   //--------------------------------------------------------------------------
   @Override
   public E set(int inIndex, E inElement)
   {
      int existingIndex = indexOf(inElement);

      super.set(inIndex, inElement);

      if (existingIndex >= 0)
      {
         remove(existingIndex);
      }

      return null;
   }

   //--------------------------------------------------------------------------
   public E first()
   {
      return (CollectionUtil.hasValues(this) ? get(0) : null);
   }

   //--------------------------------------------------------------------------
   public E last()
   {
      return (CollectionUtil.hasValues(this) ? get(size() - 1) : null);
   }

}