Package zombie.util

Class AbstractIntCollection

java.lang.Object
zombie.util.AbstractIntCollection
All Implemented Interfaces:
IntCollection
Direct Known Subclasses:
AbstractIntList, AbstractIntSet
public abstract class AbstractIntCollection extends Object implements IntCollection
This class represents an abstract base for implementing collections of int values. All operations that can be implemented using iterators are implemented as such. In most cases, this is hardly an efficient solution, and at least some of those methods should be overridden by sub-classes.

In this implementation, size() is calculated by iterating over the collection. Make sure that size() is overwritten or that iterators do not depend on the size() method.

Since:
1.0

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    add(int v)
    Throws UnsupportedOperationException.
    boolean
    addAll(IntCollection c)
    Adds all the elements of a specified collection to this collection.
    void
    clear()
    Clears this collection.
    boolean
    contains(int v)
    Indicates whether this collection contains a specified element.
    boolean
    containsAll(IntCollection c)
    Indicates whether all elements of a specified collection is contained in this collection.
    boolean
    isEmpty()
    Indicates whether this collection is empty.
    boolean
    remove(int v)
    Removes a specified element from this collection.
    boolean
    removeAll(IntCollection c)
    Removes all the elements of a specified collection from this collection.
    boolean
    retainAll(IntCollection c)
    Retains only the elements of a specified collection in this collection.
    int
    size()
    Returns the number of elements in this collection.
    int[]
    toArray()
    Returns the elements of this collection as an array.
    int[]
    toArray(int[] a)
    Returns the elements of this collection as an array.
    String
    toString()
    Returns a string representation of this collection.
    void
    trimToSize()
    Does nothing.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface zombie.util.IntCollection

    equals, hashCode, iterator

  • Method Details

    • add

      public boolean add(int v)
      Throws UnsupportedOperationException.
      Specified by:
      add in interface IntCollection
      Parameters:
      v - the element to add to this collection.
      Returns:
      true if this collection was modified as a result of adding v; returns false otherwise.
      Throws:
      UnsupportedOperationException - unconditionally.
      See Also:

    • addAll

      public boolean addAll(IntCollection c)
      Description copied from interface: IntCollection
      Adds all the elements of a specified collection to this collection.
      Specified by:
      addAll in interface IntCollection
      Parameters:
      c - the collection whose elements to add to this collection.
      Returns:
      true if this collection was modified as a result of adding the elements of c; returns false otherwise.
      See Also:

    • clear

      public void clear()
      Description copied from interface: IntCollection
      Clears this collection.
      Specified by:
      clear in interface IntCollection

    • contains

      public boolean contains(int v)
      Description copied from interface: IntCollection
      Indicates whether this collection contains a specified element.
      Specified by:
      contains in interface IntCollection
      Parameters:
      v - the element to test for containment.
      Returns:
      true if v is contained in this collection; returns false otherwise.
      See Also:

    • containsAll

      public boolean containsAll(IntCollection c)
      Description copied from interface: IntCollection
      Indicates whether all elements of a specified collection is contained in this collection.
      Specified by:
      containsAll in interface IntCollection
      Parameters:
      c - the collection whose elements to test for containment.
      Returns:
      true if all the elements of c are contained in this collection; returns false otherwise.
      See Also:

    • isEmpty

      public boolean isEmpty()
      Description copied from interface: IntCollection
      Indicates whether this collection is empty.
      Specified by:
      isEmpty in interface IntCollection
      Returns:
      true if this collection is empty; returns false otherwise.

    • remove

      public boolean remove(int v)
      Description copied from interface: IntCollection
      Removes a specified element from this collection.
      Specified by:
      remove in interface IntCollection
      Parameters:
      v - the int value to remove from this collection.
      Returns:
      true if this collection was modified as a result of removing v; returns false otherwise.

    • removeAll

      public boolean removeAll(IntCollection c)
      Description copied from interface: IntCollection
      Removes all the elements of a specified collection from this collection.
      Specified by:
      removeAll in interface IntCollection
      Parameters:
      c - the collection whose elements to remove from this collection.
      Returns:
      true if this collection was modified as a result of removing the elements of c; returns false otherwise.

    • retainAll

      public boolean retainAll(IntCollection c)
      Description copied from interface: IntCollection
      Retains only the elements of a specified collection in this collection.
      Specified by:
      retainAll in interface IntCollection
      Parameters:
      c - the collection whose elements to retain in this collection.
      Returns:
      true if this collection was modified as a result of removing the elements not contained in c; returns false otherwise.

    • size

      public int size()
      Description copied from interface: IntCollection
      Returns the number of elements in this collection.
      Specified by:
      size in interface IntCollection
      Returns:
      the number of elements in this collection.

    • toArray

      public int[] toArray()
      Description copied from interface: IntCollection
      Returns the elements of this collection as an array.
      Specified by:
      toArray in interface IntCollection
      Returns:
      a new array containing the elements of this collection.

    • toArray

      public int[] toArray(int[] a)
      Description copied from interface: IntCollection
      Returns the elements of this collection as an array.
      Specified by:
      toArray in interface IntCollection
      Parameters:
      a - an array to fill with the elements of this collection; if a is null or not big enough to contain all the elements of this collection, an new array is allocated, and a is not changed.
      Returns:
      a, if a has room for all the elements of this collection; otherwise a new array is allocated, filled with the elements of this collection, and returned.

    • trimToSize

      public void trimToSize()
      Does nothing. Sub-classes may provide an implementation to minimize memory usage, but this is not required since many implementations will always have minimal memory usage.
      Specified by:
      trimToSize in interface IntCollection

    • toString

      public String toString()
      Returns a string representation of this collection.
      Overrides:
      toString in class Object
      Returns:
      a string representation of this collection.