Module com.carrotsearch.hppc
Package com.carrotsearch.hppc

Class ShortObjectHashMap.KeysContainer

java.lang.Object
com.carrotsearch.hppc.ShortObjectHashMap.KeysContainer
All Implemented Interfaces:
ShortCollection, ShortContainer, ShortLookupContainer, Iterable<ShortCursor>
Enclosing class:
ShortObjectHashMap<VType>
public final class ShortObjectHashMap.KeysContainer extends Object implements ShortLookupContainer
A view of the keys inside this hash map.

  • Constructor Details

    • KeysContainer

      public KeysContainer()

  • Method Details

    • contains

      public boolean contains(short e)
      Description copied from interface: ShortContainer
      Lookup a given element in the container. This operation has no speed guarantees (may be linear with respect to the size of this container).
      Specified by:
      contains in interface ShortContainer
      Specified by:
      contains in interface ShortLookupContainer
      Returns:
      Returns true if this container has an element equal to e.

    • forEach

      public <T extends ShortProcedure> T forEach(T procedure)
      Description copied from interface: ShortContainer
      Applies a procedure to all container elements. Returns the argument (any subclass of ShortProcedure. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example (IntContainer): 
       int count = container.forEach(new IntProcedure() {
   int count; // this is a field declaration in an anonymous class.

   public void apply(int value) {
     count++;
   }
 }).count;
      Specified by:
      forEach in interface ShortContainer

    • forEach

      public <T extends ShortPredicate> T forEach(T predicate)
      Description copied from interface: ShortContainer
      Applies a predicate to container elements as long, as the predicate returns true. The iteration is interrupted otherwise.
      Specified by:
      forEach in interface ShortContainer

    • isEmpty

      public boolean isEmpty()
      Description copied from interface: ShortContainer
      Shortcut for size() == 0.
      Specified by:
      isEmpty in interface ShortContainer

    • iterator

      public Iterator<ShortCursor> iterator()
      Description copied from interface: ShortContainer
      Returns an iterator to a cursor traversing the collection. The order of traversal is not defined. More than one cursor may be active at a time. The behavior of iterators is undefined if structural changes are made to the underlying collection.

      The iterator is implemented as a cursor and it returns the same cursor instance on every call to Iterator.next() (to avoid boxing of primitive types). To read the current list's value (or index in the list) use the cursor's public fields. An example is shown below. 

       for (ShortCursor<short> c : container) {
   System.out.println("index=" + c.index + " value=" + c.value);
 }
      Specified by:
      iterator in interface Iterable<ShortCursor>
      Specified by:
      iterator in interface ShortContainer

    • size

      public int size()
      Description copied from interface: ShortContainer
      Return the current number of elements in this container. The time for calculating the container's size may take O(n) time, although implementing classes should try to maintain the current size and return in constant time.
      Specified by:
      size in interface ShortContainer

    • clear

      public void clear()
      Description copied from interface: ShortCollection
      Removes all elements from this collection.
      Specified by:
      clear in interface ShortCollection
      See Also:

    • release

      public void release()
      Description copied from interface: ShortCollection
      Removes all elements from the collection and additionally releases any internal buffers. Typically, if the object is to be reused, a simple ShortCollection.clear() should be a better alternative since it'll avoid reallocation.
      Specified by:
      release in interface ShortCollection
      See Also:

    • removeAll

      public int removeAll(ShortPredicate predicate)
      Description copied from interface: ShortCollection
      Removes all elements in this collection for which the given predicate returns true .
      Specified by:
      removeAll in interface ShortCollection
      Returns:
      Returns the number of removed elements.

    • removeAll

      public int removeAll(short e)
      Description copied from interface: ShortCollection
      Removes all occurrences of e from this collection.
      Specified by:
      removeAll in interface ShortCollection
      Parameters:
      e - Element to be removed from this collection, if present.
      Returns:
      The number of removed elements as a result of this call.

    • removeAll

      public int removeAll(ShortLookupContainer c)
      Default implementation uses a predicate for removal.
      Specified by:
      removeAll in interface ShortCollection
      Returns:
      Returns the number of removed elements.

    • retainAll

      public int retainAll(ShortLookupContainer c)
      Default implementation uses a predicate for retaining.
      Specified by:
      retainAll in interface ShortCollection
      Returns:
      Returns the number of removed elements.

    • retainAll

      public int retainAll(ShortPredicate predicate)
      Default implementation redirects to ShortCollection.removeAll(ShortPredicate) and negates the predicate.
      Specified by:
      retainAll in interface ShortCollection
      Returns:
      Returns the number of removed elements.

    • toArray

      public short[] toArray()
      Default implementation of copying to an array.
      Specified by:
      toArray in interface ShortContainer

    • toString

      public String toString()
      Convert the contents of this container to a human-friendly string.
      Overrides:
      toString in class Object