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

Modifier and Type	Class and Description
pack-priv static class	ObjectArrayList.ValueIterator<KType> An iterator implementation for `ObjectArrayList#iterator`.

Modifier and Type	Field and Description
public Object[]	buffer Internal array for storing the list.
private static final BoundedProportionalArraySizingStrategy	DEFAULT_SIZING_STRATEGY Reuse the same strategy instance.
public int	elementsCount Current number of elements stored in `buffer`.
public static final Object[]	EMPTY_ARRAY An immutable empty buffer (array).
protected final ArraySizingStrategy	resizer Buffer resizing strategy.

Access	Constructor and Description
public	ObjectArrayList() New instance with sane defaults.
public	ObjectArrayList(int The expected number of elements guaranteed not to cause buffer expansion (inclusive). expectedElements) New instance with sane defaults.
public	ObjectArrayList(int The expected number of elements guaranteed not to cause buffer expansion (inclusive). expectedElements, ArraySizingStrategy Underlying buffer sizing strategy. resizer) New instance with sane defaults.
public	ObjectArrayList(ObjectContainer<? extends KType> container) Creates a new list from the elements of another container in its iteration order.

Method Summary

Modifier and Type	Method and Description
public void	add(KType e1) Implements com.carrotsearch.hppc.ObjectIndexedContainer.add. Adds an element to the end of this container (the last index is incremented by one).
public void	add(KType e1, KType e2) Appends two elements at the end of the list.
public void	add(KType[] elements, int start, int length) Add all elements from a range of given array to the list.
public final void	add(KType... elements) Implements com.carrotsearch.hppc.ObjectIndexedContainer.add. Vararg-signature method for adding elements at the end of the list.
public int	addAll(ObjectContainer<? extends KType> container) Adds all elements from another container.
public int	addAll(Iterable<? extends ObjectCursor<? extends KType>> iterable) Adds all elements from another iterable.
public void	clear() Implements com.carrotsearch.hppc.ObjectCollection.clear. Sets the number of stored elements to zero.
public ObjectArrayList<KType>	clone() Overrides java.lang.Object.clone. Clone this object.
public boolean	contains(KType e1) Implements com.carrotsearch.hppc.ObjectContainer.contains. Lookup a given element in the container.
protected void	ensureBufferSpace(int expectedAdditions) Ensures the internal buffer has enough free slots to store `expectedAdditions`.
public void	ensureCapacity(int The total number of elements, inclusive. expectedElements) Implements com.carrotsearch.hppc.Preallocable.ensureCapacity. Ensure this container can hold at least the given number of elements without resizing its buffers.
protected boolean	equalElements(ObjectArrayList<?> other) Compare index-aligned elements against another `ObjectIndexedContainer`.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Returns `true` only if the other object is an instance of the same class and with the same elements.
public <T extends ObjectProcedure<? super KType>> T	forEach(T procedure) Implements com.carrotsearch.hppc.ObjectContainer.forEach, com.carrotsearch.hppc.ObjectContainer.forEach. Applies a `procedure` to all container elements.
public <T extends ObjectProcedure<? super KType>> T	forEach(T procedure, int fromIndex, final int toIndex) Applies `procedure` to a slice of the list, `fromIndex`, inclusive, to `toIndex`, exclusive.
public <T extends ObjectPredicate<? super KType>> T	forEach(T predicate) Implements com.carrotsearch.hppc.ObjectContainer.forEach, com.carrotsearch.hppc.ObjectContainer.forEach. Applies a `procedure` to all container elements.
public <T extends ObjectPredicate<? super KType>> T	forEach(T predicate, int fromIndex, final int toIndex) Applies `predicate` to a slice of the list, `fromIndex`, inclusive, to `toIndex`, exclusive, or until predicate returns `false`.
public static <KType> ObjectArrayList<KType>	from(KType... elements) Create a list from a variable number of arguments or an array of `Object`.
public KType	get(int index) Implements com.carrotsearch.hppc.ObjectIndexedContainer.get.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public int	indexOf(KType e1) Implements com.carrotsearch.hppc.ObjectIndexedContainer.indexOf. Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
public void	insert(int The index at which the element should be inserted, shifting any existing and subsequent elements to the right. index, KType e1) Implements com.carrotsearch.hppc.ObjectIndexedContainer.insert. Inserts the specified element at the specified position in this list.
public boolean	isEmpty() Implements com.carrotsearch.hppc.ObjectContainer.isEmpty. Shortcut for `size() == 0`.
public Iterator<ObjectCursor<KType>>	iterator() Implements com.carrotsearch.hppc.ObjectContainer.iterator. Returns an iterator to a cursor traversing the collection.
public int	lastIndexOf(KType e1) Implements com.carrotsearch.hppc.ObjectIndexedContainer.lastIndexOf. Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
public long	ramBytesAllocated() Implements com.carrotsearch.hppc.Accountable.ramBytesAllocated. Allocated memory estimation
public long	ramBytesUsed() Implements com.carrotsearch.hppc.Accountable.ramBytesUsed. Bytes that is actually been used
public void	release() Implements com.carrotsearch.hppc.ObjectCollection.release. Sets the number of stored elements to zero and releases the internal storage array.
public int	removeAll(KType Element to be removed from this collection, if present. e1) Implements com.carrotsearch.hppc.ObjectCollection.removeAll. Removes all occurrences of `e` from this collection.
public int	removeAll(ObjectPredicate<? super KType> predicate) Implements com.carrotsearch.hppc.ObjectCollection.removeAll, com.carrotsearch.hppc.ObjectCollection.removeAll. Removes all elements in this collection for which the given predicate returns `true` .
public KType	removeAt(int index) Implements com.carrotsearch.hppc.ObjectIndexedContainer.removeAt. Removes the element at the specified position in this container and returns it.
public boolean	removeElement(KType e1) Implements com.carrotsearch.hppc.ObjectIndexedContainer.removeElement. Removes the first element that equals `e1`, returning whether an element has been removed.
public int	removeFirst(KType e1) Implements com.carrotsearch.hppc.ObjectIndexedContainer.removeFirst. Removes the first element that equals `e1`, returning its deleted position or `-1` if the element was not found.
public KType	removeLast() Implements com.carrotsearch.hppc.ObjectIndexedContainer.removeLast. Removes and returns the last element of this container.
public int	removeLast(KType e1) Implements com.carrotsearch.hppc.ObjectIndexedContainer.removeLast. Removes the last element that equals `e1`, returning its deleted position or `-1` if the element was not found.
public void	removeRange(int fromIndex, int toIndex) Implements com.carrotsearch.hppc.ObjectIndexedContainer.removeRange. Removes from this container all of the elements with indexes between `fromIndex`, inclusive, and `toIndex`, exclusive.
public void	resize(int newSize) Truncate or expand the list to the new size.
public ObjectIndexedContainer<KType>	reverse() Implements com.carrotsearch.hppc.ObjectIndexedContainer.reverse. Reverses the elements in this container and returns this container.
public KType	set(int index, KType e1) Implements com.carrotsearch.hppc.ObjectIndexedContainer.set. Replaces the element at the specified position in this list with the specified element.
public int	size() Implements com.carrotsearch.hppc.ObjectContainer.size. Return the current number of elements in this container.
public ObjectIndexedContainer<KType>	sort() Implements com.carrotsearch.hppc.ObjectIndexedContainer.sort. Sorts the elements in this container and returns this container.
public Stream<KType>	stream() Implements com.carrotsearch.hppc.ObjectIndexedContainer.stream. Returns this container elements as a stream.
public Object[]	toArray() Overrides com.carrotsearch.hppc.AbstractObjectCollection.toArray. Implements com.carrotsearch.hppc.ObjectContainer.toArray. Copies all elements of this container to an array.
public void	trimToSize() Trim the internal buffer to the current size.

Inherited from com.carrotsearch.hppc.AbstractObjectCollection:: equals removeAll retainAll retainAll toArray toString

buffer	back to summary
public Object[] buffer Internal array for storing the list. The array may be larger than the current size (`size()`).

DEFAULT_SIZING_STRATEGY	back to summary
private static final BoundedProportionalArraySizingStrategy DEFAULT_SIZING_STRATEGY Reuse the same strategy instance.

elementsCount	back to summary
public int elementsCount Current number of elements stored in `buffer`.

EMPTY_ARRAY	back to summary
public static final Object[] EMPTY_ARRAY An immutable empty buffer (array).

resizer	back to summary
protected final ArraySizingStrategy resizer Buffer resizing strategy.

ObjectArrayList	back to summary
public ObjectArrayList() New instance with sane defaults.

ObjectArrayList	back to summary
public ObjectArrayList(int expectedElements) New instance with sane defaults. Parameters expectedElements:int The expected number of elements guaranteed not to cause buffer expansion (inclusive).

ObjectArrayList	back to summary
public ObjectArrayList(int expectedElements, ArraySizingStrategy resizer) New instance with sane defaults. Parameters expectedElements:int The expected number of elements guaranteed not to cause buffer expansion (inclusive). resizer:ArraySizingStrategy Underlying buffer sizing strategy.

ObjectArrayList	back to summary
public ObjectArrayList(ObjectContainer<? extends KType> container) Creates a new list from the elements of another container in its iteration order.

Method Detail

add	back to summary
public void add(KType e1) Implements com.carrotsearch.hppc.ObjectIndexedContainer.add. Doc from com.carrotsearch.hppc.ObjectIndexedContainer.add. Adds an element to the end of this container (the last index is incremented by one). Annotations @Override

add

back to summary

public void add(KType e1)

Implements com.carrotsearch.hppc.ObjectIndexedContainer.add.

Doc from com.carrotsearch.hppc.ObjectIndexedContainer.add.

Adds an element to the end of this container (the last index is incremented by one).

Annotations

@Override

add	back to summary
public void add(KType e1, KType e2) Appends two elements at the end of the list. To add more than two elements, use `add` (vararg-version) or access the buffer directly (tight loop).

add	back to summary
public void add(KType[] elements, int start, int length) Add all elements from a range of given array to the list.

add	back to summary
public final void add(KType... elements) Implements com.carrotsearch.hppc.ObjectIndexedContainer.add. Vararg-signature method for adding elements at the end of the list. This method is handy, but costly if used in tight loops (anonymous array passing) Annotations @SafeVarargs

add

back to summary

public final void add(KType... elements)

Implements com.carrotsearch.hppc.ObjectIndexedContainer.add.

Vararg-signature method for adding elements at the end of the list.

This method is handy, but costly if used in tight loops (anonymous array passing)

Annotations

@SafeVarargs

addAll	back to summary
public int addAll(ObjectContainer<? extends KType> container) Adds all elements from another container.

addAll	back to summary
public int addAll(Iterable<? extends ObjectCursor<? extends KType>> iterable) Adds all elements from another iterable.

clear back to summary

clear	back to summary
public void clear() Implements com.carrotsearch.hppc.ObjectCollection.clear. Sets the number of stored elements to zero. Releases and initializes the internal storage array to default values. To clear the list without cleaning the buffer, simply set the `elementsCount` field to zero. Annotations @Override

public void clear()

Implements com.carrotsearch.hppc.ObjectCollection.clear.

Sets the number of stored elements to zero. Releases and initializes the internal storage array to default values. To clear the list without cleaning the buffer, simply set the elementsCount field to zero.

Annotations

@Override

clone	back to summary
public ObjectArrayList<KType> clone() Overrides java.lang.Object.clone. Clone this object. The returned clone will reuse the same hash function and array resizing strategy. Returns:ObjectArrayList<KType> Doc from java.lang.Object.clone. a clone of this instance. Annotations @Override

clone

back to summary

public ObjectArrayList<KType> clone()

Overrides java.lang.Object.clone.

Clone this object. The returned clone will reuse the same hash function and array resizing strategy.

Returns:ObjectArrayList<KType>

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations

@Override

contains back to summary

contains	back to summary
public boolean contains(KType e1) Implements com.carrotsearch.hppc.ObjectContainer.contains. Doc from com.carrotsearch.hppc.ObjectContainer.contains. 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`. Annotations @Override

public boolean contains(KType e1)

Implements com.carrotsearch.hppc.ObjectContainer.contains.

Doc from com.carrotsearch.hppc.ObjectContainer.contains.

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.

Annotations

@Override

ensureBufferSpace	back to summary
protected void ensureBufferSpace(int expectedAdditions) Ensures the internal buffer has enough free slots to store `expectedAdditions`. Increases internal buffer size if needed.

ensureCapacity	back to summary
public void ensureCapacity(int expectedElements) Implements com.carrotsearch.hppc.Preallocable.ensureCapacity. Ensure this container can hold at least the given number of elements without resizing its buffers. Parameters expectedElements:int The total number of elements, inclusive. Annotations @Override

ensureCapacity

back to summary

public void ensureCapacity(int expectedElements)

Implements com.carrotsearch.hppc.Preallocable.ensureCapacity.

Ensure this container can hold at least the given number of elements without resizing its buffers.

Parameters

expectedElements:int: The total number of elements, inclusive.

Annotations

@Override

equalElements	back to summary
protected boolean equalElements(ObjectArrayList<?> other) Compare index-aligned elements against another `ObjectIndexedContainer`. Equality comparison is performed with this object's `equals(Object, Object)` method.

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Returns `true` only if the other object is an instance of the same class and with the same elements. Equality comparison is performed with this object's `equals(Object, Object)` method. Parameters obj:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Returns true only if the other object is an instance of the same class and with the same elements. Equality comparison is performed with this object's equals(Object, Object) method.

Parameters

obj:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

forEach back to summary

forEach	back to summary
public <T extends ObjectProcedure<? super KType>> T forEach(T procedure) Implements com.carrotsearch.hppc.ObjectContainer.forEach, com.carrotsearch.hppc.ObjectContainer.forEach. Doc from com.carrotsearch.hppc.ObjectContainer.forEach. 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; Annotations @Override

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

Implements com.carrotsearch.hppc.ObjectContainer.forEach, com.carrotsearch.hppc.ObjectContainer.forEach.

Doc from com.carrotsearch.hppc.ObjectContainer.forEach.

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;

Annotations

@Override

forEach	back to summary
public <T extends ObjectProcedure<? super KType>> T forEach(T procedure, int fromIndex, final int toIndex) Applies `procedure` to a slice of the list, `fromIndex`, inclusive, to `toIndex`, exclusive.

forEach back to summary

forEach	back to summary
public <T extends ObjectPredicate<? super KType>> T forEach(T predicate) Implements com.carrotsearch.hppc.ObjectContainer.forEach, com.carrotsearch.hppc.ObjectContainer.forEach. Doc from com.carrotsearch.hppc.ObjectContainer.forEach. 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; Annotations @Override

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

Implements com.carrotsearch.hppc.ObjectContainer.forEach, com.carrotsearch.hppc.ObjectContainer.forEach.

Doc from com.carrotsearch.hppc.ObjectContainer.forEach.

int count = container.forEach(new IntProcedure() {
  int count; // this is a field declaration in an anonymous class.

  public void apply(int value) {
    count++;
  }
}).count;

Annotations

@Override

forEach	back to summary
public <T extends ObjectPredicate<? super KType>> T forEach(T predicate, int fromIndex, final int toIndex) Applies `predicate` to a slice of the list, `fromIndex`, inclusive, to `toIndex`, exclusive, or until predicate returns `false`.

from back to summary

from	back to summary
public static <KType> ObjectArrayList<KType> from(KType... elements) Create a list from a variable number of arguments or an array of `Object`. The elements are copied from the argument to the internal buffer. Annotations @SafeVarargs

public static <KType> ObjectArrayList<KType> from(KType... elements)

Create a list from a variable number of arguments or an array of Object. The elements are copied from the argument to the internal buffer.

Annotations

@SafeVarargs

get back to summary

get	back to summary
public KType get(int index) Implements com.carrotsearch.hppc.ObjectIndexedContainer.get. Returns:KType Doc from com.carrotsearch.hppc.ObjectIndexedContainer.get. Returns the element at index `index` from the list. Annotations @Override

public KType get(int index)

Implements com.carrotsearch.hppc.ObjectIndexedContainer.get.

Returns:KType

Doc from com.carrotsearch.hppc.ObjectIndexedContainer.get.

Returns the element at index index from the list.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

indexOf	back to summary
public int indexOf(KType e1) Implements com.carrotsearch.hppc.ObjectIndexedContainer.indexOf. Doc from com.carrotsearch.hppc.ObjectIndexedContainer.indexOf. Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. Annotations @Override

indexOf

back to summary

public int indexOf(KType e1)

Implements com.carrotsearch.hppc.ObjectIndexedContainer.indexOf.

Doc from com.carrotsearch.hppc.ObjectIndexedContainer.indexOf.

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.

Annotations

@Override

insert	back to summary
public void insert(int index, KType e1) Implements com.carrotsearch.hppc.ObjectIndexedContainer.insert. Doc from com.carrotsearch.hppc.ObjectIndexedContainer.insert. Inserts the specified element at the specified position in this list. Parameters index:int The index at which the element should be inserted, shifting any existing and subsequent elements to the right. Annotations @Override

insert

back to summary

public void insert(int index, KType e1)

Implements com.carrotsearch.hppc.ObjectIndexedContainer.insert.

Doc from com.carrotsearch.hppc.ObjectIndexedContainer.insert.

Inserts the specified element at the specified position in this list.

Parameters

index:int: The index at which the element should be inserted, shifting any existing and subsequent elements to the right.

Annotations

@Override

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Implements com.carrotsearch.hppc.ObjectContainer.isEmpty. Doc from com.carrotsearch.hppc.ObjectContainer.isEmpty. Shortcut for `size() == 0`. Annotations @Override

public boolean isEmpty()

Implements com.carrotsearch.hppc.ObjectContainer.isEmpty.

Doc from com.carrotsearch.hppc.ObjectContainer.isEmpty.

Shortcut for size() == 0.

Annotations

@Override

iterator back to summary

iterator	back to summary
public Iterator<ObjectCursor<KType>> iterator() Implements com.carrotsearch.hppc.ObjectContainer.iterator. Doc from com.carrotsearch.hppc.ObjectContainer.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. Annotations @Override

public Iterator<ObjectCursor<KType>> iterator()

Implements com.carrotsearch.hppc.ObjectContainer.iterator.

Doc from com.carrotsearch.hppc.ObjectContainer.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.

Annotations

@Override

lastIndexOf	back to summary
public int lastIndexOf(KType e1) Implements com.carrotsearch.hppc.ObjectIndexedContainer.lastIndexOf. Doc from com.carrotsearch.hppc.ObjectIndexedContainer.lastIndexOf. Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. Annotations @Override

lastIndexOf

back to summary

public int lastIndexOf(KType e1)

Implements com.carrotsearch.hppc.ObjectIndexedContainer.lastIndexOf.

Doc from com.carrotsearch.hppc.ObjectIndexedContainer.lastIndexOf.

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.

Annotations

@Override

ramBytesAllocated	back to summary
public long ramBytesAllocated() Implements com.carrotsearch.hppc.Accountable.ramBytesAllocated. Doc from com.carrotsearch.hppc.Accountable.ramBytesAllocated. Allocated memory estimation Returns:long Ram allocated in bytes Annotations @Override

ramBytesAllocated

back to summary

public long ramBytesAllocated()

Implements com.carrotsearch.hppc.Accountable.ramBytesAllocated.

Doc from com.carrotsearch.hppc.Accountable.ramBytesAllocated.

Allocated memory estimation

Returns:long

Ram allocated in bytes

Annotations

@Override

ramBytesUsed	back to summary
public long ramBytesUsed() Implements com.carrotsearch.hppc.Accountable.ramBytesUsed. Doc from com.carrotsearch.hppc.Accountable.ramBytesUsed. Bytes that is actually been used Returns:long Ram used in bytes Annotations @Override

ramBytesUsed

back to summary

public long ramBytesUsed()

Implements com.carrotsearch.hppc.Accountable.ramBytesUsed.

Doc from com.carrotsearch.hppc.Accountable.ramBytesUsed.

Bytes that is actually been used

Returns:long

Ram used in bytes

Annotations

@Override

release	back to summary
public void release() Implements com.carrotsearch.hppc.ObjectCollection.release. Sets the number of stored elements to zero and releases the internal storage array. Annotations @Override

release

back to summary

public void release()

Implements com.carrotsearch.hppc.ObjectCollection.release.

Sets the number of stored elements to zero and releases the internal storage array.

Annotations

@Override

removeAll back to summary

removeAll	back to summary
public int removeAll(KType e1) Implements com.carrotsearch.hppc.ObjectCollection.removeAll. Doc from com.carrotsearch.hppc.ObjectCollection.removeAll. Removes all occurrences of `e` from this collection. Parameters e1:KType Element to be removed from this collection, if present. Returns:int The number of removed elements as a result of this call. Annotations @Override

public int removeAll(KType e1)

Implements com.carrotsearch.hppc.ObjectCollection.removeAll.

Doc from com.carrotsearch.hppc.ObjectCollection.removeAll.

Removes all occurrences of e from this collection.

Parameters

e1:KType: Element to be removed from this collection, if present.

Returns:int

The number of removed elements as a result of this call.

Annotations

@Override

removeAll back to summary

removeAll	back to summary
public int removeAll(ObjectPredicate<? super KType> predicate) Implements com.carrotsearch.hppc.ObjectCollection.removeAll, com.carrotsearch.hppc.ObjectCollection.removeAll. Doc from com.carrotsearch.hppc.ObjectCollection.removeAll. Removes all elements in this collection for which the given predicate returns `true` . Returns:int Returns the number of removed elements. Annotations @Override

public int removeAll(ObjectPredicate<? super KType> predicate)

Implements com.carrotsearch.hppc.ObjectCollection.removeAll, com.carrotsearch.hppc.ObjectCollection.removeAll.

Doc from com.carrotsearch.hppc.ObjectCollection.removeAll.

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

Returns:int

Returns the number of removed elements.

Annotations

@Override

removeAt	back to summary
public KType removeAt(int index) Implements com.carrotsearch.hppc.ObjectIndexedContainer.removeAt. Doc from com.carrotsearch.hppc.ObjectIndexedContainer.removeAt. Removes the element at the specified position in this container and returns it. Annotations @Override

removeAt

back to summary

public KType removeAt(int index)

Implements com.carrotsearch.hppc.ObjectIndexedContainer.removeAt.

Doc from com.carrotsearch.hppc.ObjectIndexedContainer.removeAt.

Removes the element at the specified position in this container and returns it.

Annotations

@Override

removeElement back to summary

removeElement	back to summary
public boolean removeElement(KType e1) Implements com.carrotsearch.hppc.ObjectIndexedContainer.removeElement. Doc from com.carrotsearch.hppc.ObjectIndexedContainer.removeElement. Removes the first element that equals `e1`, returning whether an element has been removed. Annotations @Override

public boolean removeElement(KType e1)

Implements com.carrotsearch.hppc.ObjectIndexedContainer.removeElement.

Doc from com.carrotsearch.hppc.ObjectIndexedContainer.removeElement.

Removes the first element that equals e1, returning whether an element has been removed.

Annotations

@Override

removeFirst back to summary

removeFirst	back to summary
public int removeFirst(KType e1) Implements com.carrotsearch.hppc.ObjectIndexedContainer.removeFirst. Doc from com.carrotsearch.hppc.ObjectIndexedContainer.removeFirst. Removes the first element that equals `e1`, returning its deleted position or `-1` if the element was not found. Annotations @Override

public int removeFirst(KType e1)

Implements com.carrotsearch.hppc.ObjectIndexedContainer.removeFirst.

Doc from com.carrotsearch.hppc.ObjectIndexedContainer.removeFirst.

Removes the first element that equals e1, returning its deleted position or -1 if the element was not found.

Annotations

@Override

removeLast	back to summary
public KType removeLast() Implements com.carrotsearch.hppc.ObjectIndexedContainer.removeLast. Doc from com.carrotsearch.hppc.ObjectIndexedContainer.removeLast. Removes and returns the last element of this container. This container must not be empty. Annotations @Override

removeLast

back to summary

public KType removeLast()

Implements com.carrotsearch.hppc.ObjectIndexedContainer.removeLast.

Doc from com.carrotsearch.hppc.ObjectIndexedContainer.removeLast.

Removes and returns the last element of this container. This container must not be empty.

Annotations

@Override

removeLast back to summary

removeLast	back to summary
public int removeLast(KType e1) Implements com.carrotsearch.hppc.ObjectIndexedContainer.removeLast. Doc from com.carrotsearch.hppc.ObjectIndexedContainer.removeLast. Removes the last element that equals `e1`, returning its deleted position or `-1` if the element was not found. Annotations @Override

public int removeLast(KType e1)

Implements com.carrotsearch.hppc.ObjectIndexedContainer.removeLast.

Doc from com.carrotsearch.hppc.ObjectIndexedContainer.removeLast.

Removes the last element that equals e1, returning its deleted position or -1 if the element was not found.

Annotations

@Override

removeRange back to summary

removeRange	back to summary
public void removeRange(int fromIndex, int toIndex) Implements com.carrotsearch.hppc.ObjectIndexedContainer.removeRange. Doc from com.carrotsearch.hppc.ObjectIndexedContainer.removeRange. Removes from this container all of the elements with indexes between `fromIndex`, inclusive, and `toIndex`, exclusive. Annotations @Override

public void removeRange(int fromIndex, int toIndex)

Implements com.carrotsearch.hppc.ObjectIndexedContainer.removeRange.

Doc from com.carrotsearch.hppc.ObjectIndexedContainer.removeRange.

Removes from this container all of the elements with indexes between fromIndex, inclusive, and toIndex, exclusive.

Annotations

@Override

resize	back to summary
public void resize(int newSize) Truncate or expand the list to the new size. If the list is truncated, the buffer will not be reallocated (use `trimToSize()` if you need a truncated buffer), but the truncated values will be reset to the default value (zero). If the list is expanded, the elements beyond the current size are initialized with JVM-defaults (zero or `null` values).

reverse

back to summary

public ObjectIndexedContainer<KType> reverse()

Implements com.carrotsearch.hppc.ObjectIndexedContainer.reverse.

Doc from com.carrotsearch.hppc.ObjectIndexedContainer.reverse.

Reverses the elements in this container and returns this container.

Annotations

@Override

set

back to summary

public KType set(int index, KType e1)

Implements com.carrotsearch.hppc.ObjectIndexedContainer.set.

Doc from com.carrotsearch.hppc.ObjectIndexedContainer.set.

Replaces the element at the specified position in this list with the specified element.

Returns:KType

Returns the previous value in the list.

Annotations

@Override

size back to summary

public int size()

Implements com.carrotsearch.hppc.ObjectContainer.size.

Doc from com.carrotsearch.hppc.ObjectContainer.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.

Annotations