Package zombie.util

Interface IntCollection

All Known Subinterfaces:
IntList, IntSet
All Known Implementing Classes:
AbstractIntCollection, AbstractIntList, AbstractIntSet, IntArrayList, IntOpenHashSet

public interface IntCollection
This interface defines collections of int values.
Since:
1.0
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    add(int v)
    Adds an element to this collection.
    boolean
    Adds all the elements of a specified collection to this collection.
    void
    Clears this collection.
    boolean
    contains(int v)
    Indicates whether this collection contains a specified element.
    boolean
    Indicates whether all elements of a specified collection is contained in this collection.
    boolean
    Indicates whether this collection is equal to some object.
    int
    Returns a hash code value for this collection.
    boolean
    Indicates whether this collection is empty.
    Returns an iterator over this collection.
    boolean
    remove(int v)
    Removes a specified element from this collection.
    boolean
    Removes all the elements of a specified collection from this collection.
    boolean
    Retains only the elements of a specified collection in this collection.
    int
    Returns the number of elements in this collection.
    int[]
    Returns the elements of this collection as an array.
    int[]
    toArray(int[] a)
    Returns the elements of this collection as an array.
    void
    Minimizes the memory used by this collection.
  • Method Details

    • add

      boolean add(int v)
      Adds an element to this collection.
      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 - if the operation is not supported by this collection.
      See Also:
    • addAll

      boolean addAll(IntCollection c)
      Adds all the elements of a specified collection to this collection.
      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.
      Throws:
      UnsupportedOperationException - if the operation is not supported by this collection.
      NullPointerException - if c is null.
      See Also:
    • clear

      void clear()
      Clears this collection.
      Throws:
      UnsupportedOperationException - if the operation is not supported by this collection.
    • contains

      boolean contains(int v)
      Indicates whether this collection contains a specified element.
      Parameters:
      v - the element to test for containment.
      Returns:
      true if v is contained in this collection; returns false otherwise.
      See Also:
    • containsAll

      boolean containsAll(IntCollection c)
      Indicates whether all elements of a specified collection is contained in this collection.
      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.
      Throws:
      NullPointerException - if c is null.
      See Also:
    • equals

      boolean equals(Object obj)
      Indicates whether this collection is equal to some object.
      Overrides:
      equals in class Object
      Parameters:
      obj - the object with which to compare this collection.
      Returns:
      true if this collection is equals to obj; returns false otherwise.
    • hashCode

      int hashCode()
      Returns a hash code value for this collection.
      Overrides:
      hashCode in class Object
      Returns:
      a hash code value for this collection.
    • isEmpty

      boolean isEmpty()
      Indicates whether this collection is empty.
      Returns:
      true if this collection is empty; returns false otherwise.
    • iterator

      IntIterator iterator()
      Returns an iterator over this collection.
      Returns:
      an iterator over this collection.
    • remove

      boolean remove(int v)
      Removes a specified element from this collection.
      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.
      Throws:
      UnsupportedOperationException - if the operation is not supported by this collection.
    • removeAll

      boolean removeAll(IntCollection c)
      Removes all the elements of a specified collection from this collection.
      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.
      Throws:
      UnsupportedOperationException - if the operation is not supported by this collection.
      NullPointerException - if c is null.
    • retainAll

      boolean retainAll(IntCollection c)
      Retains only the elements of a specified collection in this collection.
      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.
      Throws:
      UnsupportedOperationException - if the operation is not supported by this collection.
      NullPointerException - if c is null.
    • size

      int size()
      Returns the number of elements in this collection.
      Returns:
      the number of elements in this collection.
    • toArray

      int[] toArray()
      Returns the elements of this collection as an array.
      Returns:
      a new array containing the elements of this collection.
    • toArray

      int[] toArray(int[] a)
      Returns the elements of this collection as an array.
      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

      void trimToSize()
      Minimizes the memory used by this collection. The exact operation of this method depends on the class implementing it. Implementors may choose to ignore it completely.