com.carrotsearch.hppcrt

Class AbstractObjectCollection<KType>

java.lang.Object

com.carrotsearch.hppcrt.AbstractObjectCollection<KType>

All Implemented Interfaces:

ObjectCollection<KType>, ObjectContainer<KType>, java.lang.Iterable<ObjectCursor<KType>>

Direct Known Subclasses:

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

@Generated(date="2017-07-11T19:16:21+0200",
           value="AbstractKTypeCollection.java")
public abstract class AbstractObjectCollection<KType>
extends java.lang.Object
implements ObjectCollection<KType>

Common superclass for collections.

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjectPredicate<KType>	containsNegateTestPredicate
protected ObjectPredicate<KType>	containsTestPredicate
protected ObjectPredicate<KType>	negatePredicate
protected ObjectLookupContainer<? super KType>	testContainer
protected ObjectPredicate<? super KType>	testPredicate

Constructor Summary

Constructors

Constructor and Description
AbstractObjectCollection()

Method Summary

Modifier and Type	Method and Description
boolean	isEmpty() True if there is no elements in the container, equivalent to size() == 0
int	removeAll(ObjectLookupContainer<? super KType> c) Default implementation uses a predicate for removal.
int	retainAll(ObjectLookupContainer<? super KType> c) Keeps all elements in this collection that are present in c.
int	retainAll(ObjectPredicate<? super KType> predicate) Keeps all elements in this collection for which the given predicate returns true.
java.lang.Object[]	toArray() Copies all elements from this container to an array.
<T> T[]	toArray(java.lang.Class<T> componentClass) Default implementation for: Copies all elements of this container to a dynamically created array of the given component type.
KType[]	toArray(KType[] target) Default implementation for: Copies all elements of this container to an existing array of the same 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.hppcrt.ObjectCollection

clear, removeAll, removeAll

Methods inherited from interface com.carrotsearch.hppcrt.ObjectContainer

capacity, contains, forEach, forEach, iterator, size

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

testContainer

protected ObjectLookupContainer<? super KType> testContainer

testPredicate

protected ObjectPredicate<? super KType> testPredicate

containsTestPredicate

protected ObjectPredicate<KType> containsTestPredicate

containsNegateTestPredicate

protected ObjectPredicate<KType> containsNegateTestPredicate

negatePredicate

protected ObjectPredicate<KType> negatePredicate

Constructor Detail

AbstractObjectCollection

public AbstractObjectCollection()

Method Detail

removeAll

public int removeAll(ObjectLookupContainer<? super KType> c)

Default implementation uses a predicate for removal.

Specified by:

removeAll in interface ObjectCollection<KType>

Returns:

Returns the number of removed elements.

retainAll

public int retainAll(ObjectLookupContainer<? super KType> c)

Keeps all elements in this collection that are present in c. Runs in time proportional to the number of elements in this collection. Equivalent of sets intersection.

Specified by:

retainAll in interface ObjectCollection<KType>

Returns:

Returns the number of removed elements.

retainAll

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

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

Specified by:

retainAll in interface ObjectCollection<KType>

Returns:

Returns the number of removed elements.

toArray

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

Default implementation for: 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.

Specified by:

toArray in interface ObjectContainer<KType>

toArray

public KType[] toArray(KType[] target)

Default implementation for: Copies all elements of this container to an existing array of the same type.

Specified by:

toArray in interface ObjectContainer<KType>

Parameters:

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

Returns:

Returns the target argument for chaining.

toArray

public 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 ObjectContainer.toArray(Class).

Specified by:

toArray in interface ObjectContainer<KType>

See Also:

ObjectContainer.toArray(Class)

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

isEmpty

public boolean isEmpty()

Description copied from interface: ObjectContainer

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

Specified by:

isEmpty in interface ObjectContainer<KType>