Package gnu.trove.map.hash

Class TIntLongHashMap.TKeyView

java.lang.Object
gnu.trove.map.hash.TIntLongHashMap.TKeyView
All Implemented Interfaces:
TIntSet, TIntCollection
Enclosing class:
TIntLongHashMap
protected class TIntLongHashMap.TKeyView extends Object implements TIntSet
a view onto the keys of the map.

  • Field Summary

    Fields inherited from interface gnu.trove.TIntCollection

    serialVersionUID

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    TKeyView()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    add(int entry)
    Unsupported when operating upon a Key Set view of a TIntLongMap
    Inserts a value into the set.
    boolean
    addAll(int[] array)
    Unsupported when operating upon a Key Set view of a TIntLongMap
    Adds all of the elements in the array to the set.
    boolean
    addAll(TIntCollection collection)
    Unsupported when operating upon a Key Set view of a TIntLongMap
    Adds all of the elements in the TIntCollection to the set.
    boolean
    addAll(Collection<? extends Integer> collection)
    Unsupported when operating upon a Key Set view of a TIntLongMap
    Adds all of the elements in collection to the set.
    void
    clear()
    Empties the set.
    boolean
    contains(int entry)
    Returns true if this set contains the specified element.
    boolean
    containsAll(int[] array)
    Tests the set to determine if all of the elements in array are present.
    boolean
    containsAll(TIntCollection collection)
    Tests the set to determine if all of the elements in TIntCollection are present.
    boolean
    containsAll(Collection<?> collection)
    Tests the set to determine if all of the elements in collection are present.
    boolean
    equals(Object other)
    Compares the specified object with this set for equality.
    boolean
    forEach(TIntProcedure procedure)
    Executes procedure for each element in the set.
    int
    getNoEntryValue()
    Returns the value that is used to represent null.
    int
    hashCode()
    Returns the hash code value for this set.
    boolean
    isEmpty()
    Returns true if this set contains no elements.
    TIntIterator
    iterator()
    Creates an iterator over the values of the set.
    boolean
    remove(int entry)
    Removes entry from the set.
    boolean
    removeAll(int[] array)
    Removes all of the elements in array from the set.
    boolean
    removeAll(TIntCollection collection)
    Removes all of the elements in TIntCollection from the set.
    boolean
    removeAll(Collection<?> collection)
    Removes all of the elements in collection from the set.
    boolean
    retainAll(int[] array)
    Removes any values in the set which are not contained in array.
    boolean
    retainAll(TIntCollection collection)
    Removes any values in the set which are not contained in TIntCollection.
    boolean
    retainAll(Collection<?> collection)
    Removes any values in the set which are not contained in collection.
    int
    size()
    Returns the number of elements in this set (its cardinality).
    int[]
    toArray()
    Returns an array containing all of the elements in this set.
    int[]
    toArray(int[] dest)
    Returns an array containing elements in this set.
    String
    toString()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TKeyView

      protected TKeyView()

  • Method Details

    • iterator

      public TIntIterator iterator()
      Creates an iterator over the values of the set. The iterator supports element deletion.
      Specified by:
      iterator in interface TIntCollection
      Specified by:
      iterator in interface TIntSet
      Returns:
      an TIntIterator value

    • getNoEntryValue

      public int getNoEntryValue()
      Returns the value that is used to represent null. The default value is generally zero, but can be configured during construction of the collection.
      Specified by:
      getNoEntryValue in interface TIntCollection
      Specified by:
      getNoEntryValue in interface TIntSet
      Returns:
      the value that represents null

    • size

      public int size()
      Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
      Specified by:
      size in interface TIntCollection
      Specified by:
      size in interface TIntSet
      Returns:
      the number of elements in this set (its cardinality)

    • isEmpty

      public boolean isEmpty()
      Returns true if this set contains no elements.
      Specified by:
      isEmpty in interface TIntCollection
      Specified by:
      isEmpty in interface TIntSet
      Returns:
      true if this set contains no elements

    • contains

      public boolean contains(int entry)
      Returns true if this set contains the specified element.
      Specified by:
      contains in interface TIntCollection
      Specified by:
      contains in interface TIntSet
      Parameters:
      entry - an int value
      Returns:
      true if the set contains the specified element.

    • toArray

      public int[] toArray()
      Returns an array containing all of the elements in this set. If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

      The returned array will be "safe" in that no references to it are maintained by this set. (In other words, this method must allocate a new array even if this set is backed by an 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 TIntCollection
      Specified by:
      toArray in interface TIntSet
      Returns:
      an array containing all the elements in this set

    • toArray

      public int[] toArray(int[] dest)
      Returns an array containing elements in this set.

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

      If the native array is smaller than the set size, the array will be filled with elements in Iterator order until it is full and exclude the remainder.

      If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

      Specified by:
      toArray in interface TIntCollection
      Specified by:
      toArray in interface TIntSet
      Parameters:
      dest - the array into which the elements of this set are to be stored.
      Returns:
      an int[] containing all the elements in this set

    • add

      public boolean add(int entry)
      Unsupported when operating upon a Key Set view of a TIntLongMap
      Inserts a value into the set.
      Specified by:
      add in interface TIntCollection
      Specified by:
      add in interface TIntSet
      Parameters:
      entry - a int value
      Returns:
      true if the set was modified by the add operation

    • remove

      public boolean remove(int entry)
      Removes entry from the set.
      Specified by:
      remove in interface TIntCollection
      Specified by:
      remove in interface TIntSet
      Parameters:
      entry - an int value
      Returns:
      true if the set was modified by the remove operation.

    • containsAll

      public boolean containsAll(Collection<?> collection)
      Tests the set to determine if all of the elements in collection are present.
      Specified by:
      containsAll in interface TIntCollection
      Specified by:
      containsAll in interface TIntSet
      Parameters:
      collection - a Collection value
      Returns:
      true if all elements were present in the set.

    • containsAll

      public boolean containsAll(TIntCollection collection)
      Tests the set to determine if all of the elements in TIntCollection are present.
      Specified by:
      containsAll in interface TIntCollection
      Specified by:
      containsAll in interface TIntSet
      Parameters:
      collection - a TIntCollection value
      Returns:
      true if all elements were present in the set.

    • containsAll

      public boolean containsAll(int[] array)
      Tests the set to determine if all of the elements in array are present.
      Specified by:
      containsAll in interface TIntCollection
      Specified by:
      containsAll in interface TIntSet
      Parameters:
      array - as array of int primitives.
      Returns:
      true if all elements were present in the set.

    • addAll

      public boolean addAll(Collection<? extends Integer> collection)
      Unsupported when operating upon a Key Set view of a TIntLongMap
      Adds all of the elements in collection to the set.
      Specified by:
      addAll in interface TIntCollection
      Specified by:
      addAll in interface TIntSet
      Parameters:
      collection - a Collection value
      Returns:
      true if the set was modified by the add all operation.

    • addAll

      public boolean addAll(TIntCollection collection)
      Unsupported when operating upon a Key Set view of a TIntLongMap
      Adds all of the elements in the TIntCollection to the set.
      Specified by:
      addAll in interface TIntCollection
      Specified by:
      addAll in interface TIntSet
      Parameters:
      collection - a TIntCollection value
      Returns:
      true if the set was modified by the add all operation.

    • addAll

      public boolean addAll(int[] array)
      Unsupported when operating upon a Key Set view of a TIntLongMap
      Adds all of the elements in the array to the set.
      Specified by:
      addAll in interface TIntCollection
      Specified by:
      addAll in interface TIntSet
      Parameters:
      array - a array of int primitives.
      Returns:
      true if the set was modified by the add all operation.

    • retainAll

      public boolean retainAll(Collection<?> collection)
      Removes any values in the set which are not contained in collection.
      Specified by:
      retainAll in interface TIntCollection
      Specified by:
      retainAll in interface TIntSet
      Parameters:
      collection - a Collection value
      Returns:
      true if the set was modified by the retain all operation

    • retainAll

      public boolean retainAll(TIntCollection collection)
      Removes any values in the set which are not contained in TIntCollection.
      Specified by:
      retainAll in interface TIntCollection
      Specified by:
      retainAll in interface TIntSet
      Parameters:
      collection - a TIntCollection value
      Returns:
      true if the set was modified by the retain all operation

    • retainAll

      public boolean retainAll(int[] array)
      Removes any values in the set which are not contained in array.
      Specified by:
      retainAll in interface TIntCollection
      Specified by:
      retainAll in interface TIntSet
      Parameters:
      array - an array of int primitives.
      Returns:
      true if the set was modified by the retain all operation

    • removeAll

      public boolean removeAll(Collection<?> collection)
      Removes all of the elements in collection from the set.
      Specified by:
      removeAll in interface TIntCollection
      Specified by:
      removeAll in interface TIntSet
      Parameters:
      collection - a Collection value
      Returns:
      true if the set was modified by the remove all operation.

    • removeAll

      public boolean removeAll(TIntCollection collection)
      Removes all of the elements in TIntCollection from the set.
      Specified by:
      removeAll in interface TIntCollection
      Specified by:
      removeAll in interface TIntSet
      Parameters:
      collection - a TIntCollection value
      Returns:
      true if the set was modified by the remove all operation.

    • removeAll

      public boolean removeAll(int[] array)
      Removes all of the elements in array from the set.
      Specified by:
      removeAll in interface TIntCollection
      Specified by:
      removeAll in interface TIntSet
      Parameters:
      array - an array of int primitives.
      Returns:
      true if the set was modified by the remove all operation.

    • clear

      public void clear()
      Empties the set.
      Specified by:
      clear in interface TIntCollection
      Specified by:
      clear in interface TIntSet

    • forEach

      public boolean forEach(TIntProcedure procedure)
      Executes procedure for each element in the set.
      Specified by:
      forEach in interface TIntCollection
      Specified by:
      forEach in interface TIntSet
      Parameters:
      procedure - a TIntProcedure value
      Returns:
      false if the loop over the set terminated because the procedure returned false for some value.

    • equals

      public boolean equals(Object other)
      Description copied from interface: TIntSet
      Compares the specified object with this set for equality. Returns true if the specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the set interface.
      Specified by:
      equals in interface TIntCollection
      Specified by:
      equals in interface TIntSet
      Overrides:
      equals in class Object
      Parameters:
      other - object to be compared for equality with this set
      Returns:
      true if the specified object is equal to this set

    • hashCode

      public int hashCode()
      Description copied from interface: TIntSet
      Returns the hash code value for this set. The hash code of a set is defined to be the sum of the hash codes of the elements in the set. This ensures that s1.equals(s2) implies that s1.hashCode()==s2.hashCode() for any two sets s1 and s2, as required by the general contract of Object.hashCode().
      Specified by:
      hashCode in interface TIntCollection
      Specified by:
      hashCode in interface TIntSet
      Overrides:
      hashCode in class Object
      Returns:
      the hash code value for this set
      See Also:

    • toString

      public String toString()
      Overrides:
      toString in class Object