High Performance Primitive Collections 0.10.0 · com.carrotsearch.hppc.ObjectContainer

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: Returns `true` if this container has an element equal to `e`. contains(KType e) Lookup a given element in the container.
public <T extends ObjectProcedure<? super KType>> T	forEach(T procedure) Applies a `procedure` to all container elements.
public <T extends ObjectPredicate<? super KType>> T	forEach(T predicate) Applies a `predicate` to container elements as long, as the predicate returns `true`.
public boolean	isEmpty() Shortcut for `size() == 0`.
public Iterator<ObjectCursor<KType>>	iterator() Redeclares java.lang.Iterable.iterator. Returns an iterator to a cursor traversing the collection.
public int	size() Return the current number of elements in this container.
public Object[]	toArray() Copies all elements of this container to an array.
public <T> T[]	toArray(Class<T> componentClass) Copies all elements of this container to a dynamically created array of the given component type.

Inherited from java.lang.Iterable:: forEach spliterator

Method Detail

contains back to summary

contains	back to summary
public 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:boolean Returns `true` if this container has an element equal to `e`.

public 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:boolean: Returns true if this container has an element equal to e.

forEach back to summary

forEach	back to summary
public <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;

public <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	back to summary
public <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.

isEmpty	back to summary
public boolean isEmpty() Shortcut for `size() == 0`.

iterator back to summary

iterator	back to summary
public Iterator<ObjectCursor<KType>> iterator() Redeclares java.lang.Iterable.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); } Returns:Iterator<ObjectCursor<KType>> Doc from java.lang.Iterable.iterator. an Iterator.

public Iterator<ObjectCursor<KType>> iterator()

Redeclares java.lang.Iterable.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);
}

Returns:Iterator<ObjectCursor<KType>>

Doc from java.lang.Iterable.iterator.

an Iterator.

size	back to summary
public 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.

toArray	back to summary
public Object[] toArray() Copies all elements of this container to an array. The returned array is always a copy, regardless of the storage used by the container.

toArray

back to summary

public Object[] toArray()

Copies all elements of this container to an array.

The returned array is always a copy, regardless of the storage used by the container.

toArray	back to summary
public <T> T[] toArray(Class<T> componentClass) Copies all elements of this container to a dynamically created array of the given component type. Exceptions ArrayStoreException: Thrown if this container's elements are not assignable to the array's component type.

toArray

back to summary

public <T> T[] toArray(Class<T> componentClass)

Copies all elements of this container to a dynamically created array of the given component type.

Exceptions

ArrayStoreException:: Thrown if this container's elements are not assignable to the array's component type.

public Interface ObjectContainer<KType>

Method Summary

Method Detail