com.carrotsearch.hppc
Class IntLongOpenHashMap.KeysContainer

java.lang.Object
  extended by com.carrotsearch.hppc.IntLongOpenHashMap.KeysContainer
All Implemented Interfaces:
IntCollection, IntContainer, IntLookupContainer, java.lang.Iterable<IntCursor>
Enclosing class:
IntLongOpenHashMap

public final class IntLongOpenHashMap.KeysContainer
extends java.lang.Object
implements IntLookupContainer

A view of the keys inside this hash map.


Constructor Summary
IntLongOpenHashMap.KeysContainer()
           
 
Method Summary
 void clear()
          Removes all elements from this collection.
 boolean contains(int e)
          Lookup a given element in the container.
<T extends IntPredicate>
T
forEach(T predicate)
          Applies a predicate to container elements as long, as the predicate returns true.
<T extends IntProcedure>
T
forEach(T procedure)
          Applies a procedure to all container elements.
 boolean isEmpty()
          Shortcut for size() == 0.
 java.util.Iterator<IntCursor> iterator()
          Returns an iterator to a cursor traversing the collection.
 int removeAll(IntLookupContainer c)
          Default implementation uses a predicate for removal.
 int removeAll(IntPredicate predicate)
          Removes all elements in this collection for which the given predicate returns true.
 int removeAllOccurrences(int e)
          Removes all occurrences of e from this collection.
 int retainAll(IntLookupContainer c)
          Default implementation uses a predicate for retaining.
 int retainAll(IntPredicate predicate)
          Default implementation redirects to IntCollection.removeAll(IntPredicate) and negates the predicate.
 int size()
          Return the current number of elements in this container.
 int[] toArray()
          Default implementation of copying to an array.
 java.lang.String toString()
          Convert the contents of this container to a human-friendly string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.carrotsearch.hppc.IntContainer
toArray
 

Constructor Detail

IntLongOpenHashMap.KeysContainer

public IntLongOpenHashMap.KeysContainer()
Method Detail

contains

public boolean contains(int e)
Description copied from interface: IntContainer
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 IntContainer
Specified by:
contains in interface IntLookupContainer
Returns:
Returns true if this container has an element equal to e.

forEach

public <T extends IntProcedure> T forEach(T procedure)
Description copied from interface: IntContainer
Applies a procedure to all container elements. Returns the argument (any subclass of IntProcedure. 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 IntContainer

forEach

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

Specified by:
forEach in interface IntContainer

isEmpty

public boolean isEmpty()
Description copied from interface: IntContainer
Shortcut for size() == 0.

Specified by:
isEmpty in interface IntContainer

iterator

public java.util.Iterator<IntCursor> iterator()
Description copied from interface: IntContainer
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 (IntCursor<int> c : container) {
   System.out.println("index=" + c.index + " value=" + c.value);
 }
 

Specified by:
iterator in interface IntContainer
Specified by:
iterator in interface java.lang.Iterable<IntCursor>

size

public int size()
Description copied from interface: IntContainer
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 IntContainer

clear

public void clear()
Description copied from interface: IntCollection
Removes all elements from this collection.

Specified by:
clear in interface IntCollection

removeAll

public int removeAll(IntPredicate predicate)
Description copied from interface: IntCollection
Removes all elements in this collection for which the given predicate returns true.

Specified by:
removeAll in interface IntCollection

removeAllOccurrences

public int removeAllOccurrences(int e)
Description copied from interface: IntCollection
Removes all occurrences of e from this collection.

Specified by:
removeAllOccurrences in interface IntCollection
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(IntLookupContainer c)
Default implementation uses a predicate for removal.

Specified by:
removeAll in interface IntCollection
Returns:
Returns the number of removed elements.

retainAll

public int retainAll(IntLookupContainer c)
Default implementation uses a predicate for retaining.

Specified by:
retainAll in interface IntCollection
Returns:
Returns the number of removed elements.

retainAll

public int retainAll(IntPredicate predicate)
Default implementation redirects to IntCollection.removeAll(IntPredicate) and negates the predicate.

Specified by:
retainAll in interface IntCollection

toArray

public int[] toArray()
Default implementation of copying to an array.

Specified by:
toArray in interface IntContainer

toString

public java.lang.String toString()
Convert the contents of this container to a human-friendly string.

Overrides:
toString in class java.lang.Object


Copyright © 2011 Carrot Search s.c.. All Rights Reserved.