Package com.carrotsearch.hppc
Class ObjectByteWormMap.KeysContainer
- java.lang.Object
-
- com.carrotsearch.hppc.ObjectByteWormMap.KeysContainer
-
- All Implemented Interfaces:
ObjectCollection<KType>
,ObjectContainer<KType>
,ObjectLookupContainer<KType>
,java.lang.Iterable<ObjectCursor<KType>>
- Enclosing class:
- ObjectByteWormMap<KType>
public final class ObjectByteWormMap.KeysContainer extends java.lang.Object implements ObjectLookupContainer<KType>
A view of the keys inside this map.
-
-
Constructor Summary
Constructors Constructor Description KeysContainer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Removes all elements from this collection.boolean
contains(KType e)
Lookup a given element in the container.protected boolean
equals(java.lang.Object v1, java.lang.Object v2)
<T extends ObjectProcedure<? super KType>>
TforEach(T procedure)
Applies aprocedure
to all container elements.boolean
isEmpty()
Shortcut forsize() == 0
.java.util.Iterator<ObjectCursor<KType>>
iterator()
Returns an iterator to a cursor traversing the collection.void
release()
Removes all elements from the collection and additionally releases any internal buffers.int
removeAll(ObjectLookupContainer<? super KType> c)
Default implementation uses a predicate for removal.int
removeAll(ObjectPredicate<? super KType> predicate)
Removes all elements in this collection for which the given predicate returnstrue
.int
removeAll(KType e)
Removes all occurrences ofe
from this collection.int
retainAll(ObjectLookupContainer<? super KType> c)
Default implementation uses a predicate for retaining.int
retainAll(ObjectPredicate<? super KType> predicate)
Default implementation redirects toObjectCollection.removeAll(ObjectPredicate)
and negates the predicate.int
size()
Return the current number of elements in this container.java.lang.Object[]
toArray()
Default implementation of copying to an array.<T> T[]
toArray(java.lang.Class<T> componentClass)
Copies all elements of this container to a dynamically created array of the given component type.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.ObjectContainer
toArray, toArray
-
-
-
-
Method Detail
-
contains
public boolean contains(KType e)
Description copied from interface:ObjectContainer
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 interfaceObjectContainer<KType>
- Specified by:
contains
in interfaceObjectLookupContainer<KType>
- Returns:
- Returns
true
if this container has an element equal toe
.
-
forEach
public <T extends ObjectProcedure<? super KType>> T forEach(T procedure)
Description copied from interface:ObjectContainer
Applies aprocedure
to all container elements. Returns the argument (any subclass ofObjectProcedure
. 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 interfaceObjectContainer<KType>
-
forEach
public <T extends ObjectPredicate<? super KType>> T forEach(T predicate)
Description copied from interface:ObjectContainer
Applies apredicate
to container elements as long, as the predicate returnstrue
. The iteration is interrupted otherwise.- Specified by:
forEach
in interfaceObjectContainer<KType>
-
isEmpty
public boolean isEmpty()
Description copied from interface:ObjectContainer
Shortcut forsize() == 0
.- Specified by:
isEmpty
in interfaceObjectContainer<KType>
-
iterator
public java.util.Iterator<ObjectCursor<KType>> iterator()
Description copied from interface:ObjectContainer
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 (ObjectCursor<Object> c : container) { System.out.println("index=" + c.index + " value=" + c.value); }
- Specified by:
iterator
in interfacejava.lang.Iterable<ObjectCursor<KType>>
- Specified by:
iterator
in interfaceObjectContainer<KType>
-
size
public int size()
Description copied from interface:ObjectContainer
Return the current number of elements in this container. The time for calculating the container's size may takeO(n)
time, although implementing classes should try to maintain the current size and return in constant time.- Specified by:
size
in interfaceObjectContainer<KType>
-
clear
public void clear()
Description copied from interface:ObjectCollection
Removes all elements from this collection.- Specified by:
clear
in interfaceObjectCollection<KType>
- See Also:
ObjectCollection.release()
-
release
public void release()
Description copied from interface:ObjectCollection
Removes all elements from the collection and additionally releases any internal buffers. Typically, if the object is to be reused, a simpleObjectCollection.clear()
should be a better alternative since it'll avoid reallocation.- Specified by:
release
in interfaceObjectCollection<KType>
- See Also:
ObjectCollection.clear()
-
removeAll
public int removeAll(ObjectPredicate<? super KType> predicate)
Description copied from interface:ObjectCollection
Removes all elements in this collection for which the given predicate returnstrue
.- Specified by:
removeAll
in interfaceObjectCollection<KType>
- Returns:
- Returns the number of removed elements.
-
removeAll
public int removeAll(KType e)
Description copied from interface:ObjectCollection
Removes all occurrences ofe
from this collection.- Specified by:
removeAll
in interfaceObjectCollection<KType>
- 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(ObjectLookupContainer<? super KType> c)
Default implementation uses a predicate for removal.- Specified by:
removeAll
in interfaceObjectCollection<KType>
- Returns:
- Returns the number of removed elements.
-
retainAll
public int retainAll(ObjectLookupContainer<? super KType> c)
Default implementation uses a predicate for retaining.- Specified by:
retainAll
in interfaceObjectCollection<KType>
- Returns:
- Returns the number of removed elements.
-
retainAll
public int retainAll(ObjectPredicate<? super KType> predicate)
Default implementation redirects toObjectCollection.removeAll(ObjectPredicate)
and negates the predicate.- Specified by:
retainAll
in interfaceObjectCollection<KType>
- Returns:
- Returns the number of removed elements.
-
toArray
public java.lang.Object[] toArray()
Default implementation of copying to an array.- Specified by:
toArray
in interfaceObjectContainer<KType>
-
toArray
public <T> T[] toArray(java.lang.Class<T> componentClass)
Description copied from interface:ObjectContainer
Copies all elements of this container to a dynamically created array of the given component type.- Specified by:
toArray
in interfaceObjectContainer<KType>
-
toString
public java.lang.String toString()
Convert the contents of this container to a human-friendly string.- Overrides:
toString
in classjava.lang.Object
-
equals
protected boolean equals(java.lang.Object v1, java.lang.Object v2)
-
-