com.carrotsearch.hppcrt

Interface ObjectContainer<KType>

All Superinterfaces:

java.lang.Iterable<ObjectCursor<KType>>

All Known Subinterfaces:

ObjectCollection<KType>, ObjectDeque<KType>, ObjectIndexedContainer<KType>, ObjectLookupContainer<KType>, ObjectPriorityQueue<KType>, ObjectSet<KType>

All Known Implementing Classes:

AbstractObjectCollection, ByteObjectHashMap.ValuesCollection, CharObjectHashMap.ValuesCollection, DoubleObjectHashMap.ValuesCollection, FloatObjectHashMap.ValuesCollection, IntObjectHashMap.ValuesCollection, LongObjectHashMap.ValuesCollection, ObjectArrayDeque, ObjectArrayList, ObjectByteHashMap.KeysCollection, ObjectCharHashMap.KeysCollection, ObjectDoubleHashMap.KeysCollection, ObjectFloatHashMap.KeysCollection, ObjectHashSet, ObjectHeapPriorityQueue, ObjectIdentityHashSet, ObjectIndexedHeapPriorityQueue.ValuesCollection, ObjectIntHashMap.KeysCollection, ObjectLinkedList, ObjectLongHashMap.KeysCollection, ObjectObjectHashMap.KeysCollection, ObjectObjectHashMap.ValuesCollection, ObjectShortHashMap.KeysCollection, ShortObjectHashMap.ValuesCollection

@Generated(date="2017-07-11T19:16:23+0200",
           value="KTypeContainer.java")
public interface ObjectContainer<KType>
extends java.lang.Iterable<ObjectCursor<KType>>

A generic container holding Objects. An overview of interface relationships is given in the figure below:

Method Summary

Modifier and Type	Method and Description
int	capacity() Return the maximum number of elements this container is guaranteed to hold without reallocating.
boolean	contains(KType e) Lookup a given element in the container.
<T extends ObjectPredicate<? super KType>> T	forEach(T predicate) Applies a predicate to container elements, as long as the predicate returns true.
<T extends ObjectProcedure<? super KType>> T	forEach(T procedure) Applies a procedure to all container elements.
boolean	isEmpty() True if there is no elements in the container, equivalent to size() == 0
java.util.Iterator<ObjectCursor<KType>>	iterator() Returns an iterator to a cursor traversing the collection.
int	size() Return the current number of elements in this container.
java.lang.Object[]	toArray() Copies all elements from this container 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.
KType[]	toArray(KType[] target) Copies all elements of this container to an existing array of the same type.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

java.util.Iterator<ObjectCursor<KType>> iterator()

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 interface java.lang.Iterable<ObjectCursor<KType>>

contains

boolean contains(KType e)

Lookup a given element in the container. This operation has no speed guarantees (may be linear with respect to the size of this container).

Returns:

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

size

int size()

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.

capacity

int capacity()

Return the maximum number of elements this container is guaranteed to hold without reallocating. The time for calculating the container's capacity may take O(n) time.

isEmpty

boolean isEmpty()

True if there is no elements in the container, equivalent to size() == 0

toArray

java.lang.Object[] toArray()

Copies all elements from this container to an array.

The returned array is sized to match exactly the number of elements of the container.

If you need an array of the type identical with this container's generic type, use toArray(Class).

See Also:

toArray(Class)

toArray

<T> T[] toArray(java.lang.Class<T> componentClass)

Copies all elements of this container to a dynamically created array of the given component type. An ArrayStoreException may be thrown if this container's elements are not assignable to the array's component type. The returned array is always a copy, regardless of the storage used by the container.

Throws:

java.lang.ArrayStoreException

toArray

KType[] toArray(KType[] target)

Copies all elements of this container to an existing array of the same type.

Parameters:

target - The target array must be large enough to hold all elements, i.e >= size().

Returns:

Returns the target argument for chaining.

forEach

<T extends ObjectProcedure<? super KType>> T forEach(T procedure)

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

forEach

<T extends ObjectPredicate<? super KType>> T forEach(T predicate)

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