com.carrotsearch.hppc
Class ByteDoubleOpenHashMap.KeysContainer

java.lang.Object
  com.carrotsearch.hppc.ByteDoubleOpenHashMap.KeysContainer

All Implemented Interfaces:

ByteCollection, ByteContainer, ByteLookupContainer, java.lang.Iterable<ByteCursor>

Enclosing class:

ByteDoubleOpenHashMap

public final class ByteDoubleOpenHashMap.KeysContainer
extends java.lang.Object
implements ByteLookupContainer

A view of the keys inside this hash map.

Constructor Summary

ByteDoubleOpenHashMap.KeysContainer()

Method Summary

void	clear() Removes all elements from this collection.
boolean	contains(byte e) Lookup a given element in the container.
<T extends BytePredicate> T	forEach(T predicate) Applies a predicate to container elements as long, as the predicate returns true.
<T extends ByteProcedure> T	forEach(T procedure) Applies a procedure to all container elements.
boolean	isEmpty() Shortcut for size() == 0.
java.util.Iterator<ByteCursor>	iterator() Returns an iterator to a cursor traversing the collection.
int	removeAll(ByteLookupContainer c) Default implementation uses a predicate for removal.
int	removeAll(BytePredicate predicate) Removes all elements in this collection for which the given predicate returns true.
int	removeAllOccurrences(byte e) Removes all occurrences of e from this collection.
int	retainAll(ByteLookupContainer c) Default implementation uses a predicate for retaining.
int	retainAll(BytePredicate predicate) Default implementation redirects to ByteCollection.removeAll(BytePredicate) and negates the predicate.
int	size() Return the current number of elements in this container.
byte[]	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.ByteContainer

toArray

Constructor Detail

ByteDoubleOpenHashMap.KeysContainer

public ByteDoubleOpenHashMap.KeysContainer()

Method Detail

contains

public boolean contains(byte e)

Description copied from interface: ByteContainer

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 ByteContainer

Specified by:

contains in interface ByteLookupContainer

Returns:

Returns true if this container has an element equal to e.

forEach

public <T extends ByteProcedure> T forEach(T procedure)

Description copied from interface: ByteContainer

Applies a procedure to all container elements. Returns the argument (any subclass of ByteProcedure. 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 ByteContainer

forEach

public <T extends BytePredicate> T forEach(T predicate)

Description copied from interface: ByteContainer

Applies a predicate to container elements as long, as the predicate returns true. The iteration is interrupted otherwise.

Specified by:

forEach in interface ByteContainer

isEmpty

public boolean isEmpty()

Description copied from interface: ByteContainer

Shortcut for size() == 0.

Specified by:

isEmpty in interface ByteContainer

iterator

public java.util.Iterator<ByteCursor> iterator()

Description copied from interface: ByteContainer

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 (ByteCursor<byte> c : container) {
   System.out.println("index=" + c.index + " value=" + c.value);
 }
 

Specified by:

iterator in interface ByteContainer

Specified by:

iterator in interface java.lang.Iterable<ByteCursor>

size

public int size()

Description copied from interface: ByteContainer

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 ByteContainer

clear

public void clear()

Description copied from interface: ByteCollection

Removes all elements from this collection.

Specified by:

clear in interface ByteCollection

removeAll

public int removeAll(BytePredicate predicate)

Description copied from interface: ByteCollection

Removes all elements in this collection for which the given predicate returns true.

Specified by:

removeAll in interface ByteCollection

removeAllOccurrences

public int removeAllOccurrences(byte e)

Description copied from interface: ByteCollection

Removes all occurrences of e from this collection.

Specified by:

removeAllOccurrences in interface ByteCollection

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(ByteLookupContainer c)

Default implementation uses a predicate for removal.

Specified by:

removeAll in interface ByteCollection

Returns:

Returns the number of removed elements.

retainAll

public int retainAll(ByteLookupContainer c)

Default implementation uses a predicate for retaining.

Specified by:

retainAll in interface ByteCollection

Returns:

Returns the number of removed elements.

retainAll

public int retainAll(BytePredicate predicate)

Default implementation redirects to ByteCollection.removeAll(BytePredicate) and negates the predicate.

Specified by:

retainAll in interface ByteCollection

toArray

public byte[] toArray()

Default implementation of copying to an array.

Specified by:

toArray in interface ByteContainer

toString

public java.lang.String toString()

Convert the contents of this container to a human-friendly string.

Overrides:

toString in class java.lang.Object