Package gw.util

Class DynamicArray<E>

  • All Implemented Interfaces:
    java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>, java.util.RandomAccess
    Direct Known Subclasses:
    MethodList
    public class DynamicArray<E>
extends java.util.AbstractList<E>
implements java.util.List<E>, java.util.RandomAccess

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.Object[] data
      The array buffer into which the elements of the ArrayList are stored.
      static DynamicArray EMPTY  
      int size
      The size of the ArrayList (the number of elements it contains).

      • Fields inherited from class java.util.AbstractList

        modCount

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        DynamicArray()
      Constructs an empty list with an initial capacity of ten.
        DynamicArray​(int initialCapacity)
      Constructs an empty list with the specified initial capacity.
      protected DynamicArray​(DynamicArray<E> source)  
        DynamicArray​(java.util.Collection<? extends E> c)
      Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(int index, E element)
      Inserts the specified element at the specified position in this list.
      boolean add​(E e)
      Appends the specified element to the end of this list.
      boolean addAll​(int index, java.util.Collection<? extends E> c)
      Inserts all of the elements in the specified collection into this list, starting at the specified position.
      boolean addAll​(java.util.Collection<? extends E> c)
      Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's Iterator.
      void clear()
      Removes all of the elements from this list.
      boolean contains​(java.lang.Object o)
      Returns true if this list contains the specified element.
      DynamicArray<E> copy()
      Returns a shallow copy of this ArrayList instance.
      void ensureCapacity​(int minCapacity)
      Increases the capacity of this ArrayList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
      private void fastRemove​(int index)  
      E get​(int index)
      Returns the element at the specified position in this list.
      int indexOf​(java.lang.Object o)
      Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
      boolean isEmpty()
      Returns true if this list contains no elements.
      int lastIndexOf​(java.lang.Object o)
      Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
      private void RangeCheck​(int index)
      Checks if the given index is in range.
      E remove​(int index)
      Removes the element at the specified position in this list.
      boolean remove​(java.lang.Object o)
      Removes the first occurrence of the specified element from this list, if it is present.
      protected void removeRange​(int fromIndex, int toIndex)
      Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive.
      E set​(int index, E element)
      Replaces the element at the specified position in this list with the specified element.
      int size()
      Returns the number of elements in this list.
      java.lang.Object[] toArray()
      Returns an array containing all of the elements in this list in proper sequence (from first to last element).
      <T> T[] toArray​(T[] a)
      Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array.
      void trimToSize()
      Trims the capacity of this ArrayList instance to be the list's current size.

      • Methods inherited from class java.util.AbstractList

        equals, hashCode, iterator, listIterator, listIterator, subList

      • Methods inherited from class java.util.AbstractCollection

        containsAll, removeAll, retainAll, toString

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Collection

        parallelStream, removeIf, stream, toArray

      • Methods inherited from interface java.lang.Iterable

        forEach

      • Methods inherited from interface java.util.List

        containsAll, equals, hashCode, iterator, listIterator, listIterator, removeAll, replaceAll, retainAll, sort, spliterator, subList

    • Field Detail

      • data

        public transient java.lang.Object[] data
        The array buffer into which the elements of the ArrayList are stored. The capacity of the ArrayList is the length of this array buffer.

      • size

        public int size
        The size of the ArrayList (the number of elements it contains).

    • Constructor Detail

      • DynamicArray

        public DynamicArray​(int initialCapacity)
        Constructs an empty list with the specified initial capacity.
        Parameters:
        initialCapacity - the initial capacity of the list
        Throws:
        java.lang.IllegalArgumentException - if the specified initial capacity is negative

      • DynamicArray

        public DynamicArray()
        Constructs an empty list with an initial capacity of ten.

      • DynamicArray

        public DynamicArray​(java.util.Collection<? extends E> c)
        Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator.
        Parameters:
        c - the collection whose elements are to be placed into this list
        Throws:
        java.lang.NullPointerException - if the specified collection is null

      • DynamicArray

        protected DynamicArray​(DynamicArray<E> source)

    • Method Detail

      • copy

        public DynamicArray<E> copy()
        Returns a shallow copy of this ArrayList instance. (The elements themselves are not copied.)
        Returns:
        a copy of this DynamicArray instance

      • trimToSize

        public void trimToSize()
        Trims the capacity of this ArrayList instance to be the list's current size. An application can use this operation to minimize the storage of an ArrayList instance.

      • ensureCapacity

        public void ensureCapacity​(int minCapacity)
        Increases the capacity of this ArrayList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
        Parameters:
        minCapacity - the desired minimum capacity

      • size

        public int size()
        Returns the number of elements in this list.
        Specified by:
        size in interface java.util.Collection<E>
        Specified by:
        size in interface java.util.List<E>
        Specified by:
        size in class java.util.AbstractCollection<E>
        Returns:
        the number of elements in this list

      • isEmpty

        public boolean isEmpty()
        Returns true if this list contains no elements.
        Specified by:
        isEmpty in interface java.util.Collection<E>
        Specified by:
        isEmpty in interface java.util.List<E>
        Overrides:
        isEmpty in class java.util.AbstractCollection<E>
        Returns:
        true if this list contains no elements

      • contains

        public boolean contains​(java.lang.Object o)
        Returns true if this list contains the specified element. More formally, returns true if and only if this list contains at least one element e such that (o==null ? e==null : o.equals(e)).
        Specified by:
        contains in interface java.util.Collection<E>
        Specified by:
        contains in interface java.util.List<E>
        Overrides:
        contains in class java.util.AbstractCollection<E>
        Parameters:
        o - element whose presence in this list is to be tested
        Returns:
        true if this list contains the specified element

      • indexOf

        public int indexOf​(java.lang.Object o)
        Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
        Specified by:
        indexOf in interface java.util.List<E>
        Overrides:
        indexOf in class java.util.AbstractList<E>

      • lastIndexOf

        public int lastIndexOf​(java.lang.Object o)
        Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the highest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
        Specified by:
        lastIndexOf in interface java.util.List<E>
        Overrides:
        lastIndexOf in class java.util.AbstractList<E>

      • toArray

        public java.lang.Object[] toArray()
        Returns an array containing all of the elements in this list in proper sequence (from first to last element).

        The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.

        This method acts as bridge between array-based and collection-based APIs.

        Specified by:
        toArray in interface java.util.Collection<E>
        Specified by:
        toArray in interface java.util.List<E>
        Overrides:
        toArray in class java.util.AbstractCollection<E>
        Returns:
        an array containing all of the elements in this list in proper sequence

      • toArray

        public <T> T[] toArray​(T[] a)
        Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array. If the list fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this list.

        If the list fits in the specified array with room to spare (i.e., the array has more elements than the list), the element in the array immediately following the end of the collection is set to null. (This is useful in determining the length of the list only if the caller knows that the list does not contain any null elements.)

        Specified by:
        toArray in interface java.util.Collection<E>
        Specified by:
        toArray in interface java.util.List<E>
        Overrides:
        toArray in class java.util.AbstractCollection<E>
        Parameters:
        a - the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.
        Returns:
        an array containing the elements of the list
        Throws:
        java.lang.ArrayStoreException - if the runtime type of the specified array is not a supertype of the runtime type of every element in this list
        java.lang.NullPointerException - if the specified array is null

      • get

        public E get​(int index)
        Returns the element at the specified position in this list.
        Specified by:
        get in interface java.util.List<E>
        Specified by:
        get in class java.util.AbstractList<E>
        Parameters:
        index - index of the element to return
        Returns:
        the element at the specified position in this list
        Throws:
        java.lang.IndexOutOfBoundsException

      • set

        public E set​(int index,
             E element)
        Replaces the element at the specified position in this list with the specified element.
        Specified by:
        set in interface java.util.List<E>
        Overrides:
        set in class java.util.AbstractList<E>
        Parameters:
        index - index of the element to replace
        element - element to be stored at the specified position
        Returns:
        the element previously at the specified position
        Throws:
        java.lang.IndexOutOfBoundsException

      • add

        public boolean add​(E e)
        Appends the specified element to the end of this list.
        Specified by:
        add in interface java.util.Collection<E>
        Specified by:
        add in interface java.util.List<E>
        Overrides:
        add in class java.util.AbstractList<E>
        Parameters:
        e - element to be appended to this list
        Returns:
        true (as specified by Collection.add(E))

      • add

        public void add​(int index,
                E element)
        Inserts the specified element at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).
        Specified by:
        add in interface java.util.List<E>
        Overrides:
        add in class java.util.AbstractList<E>
        Parameters:
        index - index at which the specified element is to be inserted
        element - element to be inserted
        Throws:
        java.lang.IndexOutOfBoundsException

      • remove

        public E remove​(int index)
        Removes the element at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices).
        Specified by:
        remove in interface java.util.List<E>
        Overrides:
        remove in class java.util.AbstractList<E>
        Parameters:
        index - the index of the element to be removed
        Returns:
        the element that was removed from the list
        Throws:
        java.lang.IndexOutOfBoundsException

      • remove

        public boolean remove​(java.lang.Object o)
        Removes the first occurrence of the specified element from this list, if it is present. If the list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))) (if such an element exists). Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).
        Specified by:
        remove in interface java.util.Collection<E>
        Specified by:
        remove in interface java.util.List<E>
        Overrides:
        remove in class java.util.AbstractCollection<E>
        Parameters:
        o - element to be removed from this list, if present
        Returns:
        true if this list contained the specified element

      • fastRemove

        private void fastRemove​(int index)

      • clear

        public void clear()
        Removes all of the elements from this list. The list will be empty after this call returns.
        Specified by:
        clear in interface java.util.Collection<E>
        Specified by:
        clear in interface java.util.List<E>
        Overrides:
        clear in class java.util.AbstractList<E>

      • addAll

        public boolean addAll​(java.util.Collection<? extends E> c)
        Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's Iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this list, and this list is nonempty.)
        Specified by:
        addAll in interface java.util.Collection<E>
        Specified by:
        addAll in interface java.util.List<E>
        Overrides:
        addAll in class java.util.AbstractCollection<E>
        Parameters:
        c - collection containing elements to be added to this list
        Returns:
        true if this list changed as a result of the call
        Throws:
        java.lang.NullPointerException - if the specified collection is null

      • addAll

        public boolean addAll​(int index,
                      java.util.Collection<? extends E> c)
        Inserts all of the elements in the specified collection into this list, starting at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in the list in the order that they are returned by the specified collection's iterator.
        Specified by:
        addAll in interface java.util.List<E>
        Overrides:
        addAll in class java.util.AbstractList<E>
        Parameters:
        index - index at which to insert the first element from the specified collection
        c - collection containing elements to be added to this list
        Returns:
        true if this list changed as a result of the call
        Throws:
        java.lang.IndexOutOfBoundsException
        java.lang.NullPointerException - if the specified collection is null

      • removeRange

        protected void removeRange​(int fromIndex,
                           int toIndex)
        Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive. Shifts any succeeding elements to the left (reduces their index). This call shortens the list by (toIndex - fromIndex) elements. (If toIndex==fromIndex, this operation has no effect.)
        Overrides:
        removeRange in class java.util.AbstractList<E>
        Parameters:
        fromIndex - index of first element to be removed
        toIndex - index after last element to be removed
        Throws:
        java.lang.IndexOutOfBoundsException - if fromIndex or toIndex out of range (fromIndex < 0 || fromIndex >= size() || toIndex > size() || toIndex < fromIndex)

      • RangeCheck

        private void RangeCheck​(int index)
        Checks if the given index is in range. If not, throws an appropriate runtime exception. This method does *not* check if the index is negative: It is always used immediately prior to an array access, which throws an ArrayIndexOutOfBoundsException if index is negative.