@Generated(date="2023-04-24T17:14:50+0800",
value="KTypeArrayDeque.java")
public class ObjectArrayDeque<KType>
extends AbstractObjectCollection<KType>
implements ObjectDeque<KType>, Preallocable, java.lang.Cloneable
ObjectDeque.| Modifier and Type | Class and Description |
|---|---|
private class |
ObjectArrayDeque.DescendingValueIterator
An iterator implementation for
descendingIterator(). |
private class |
ObjectArrayDeque.ValueIterator
An iterator implementation for
iterator(). |
| Modifier and Type | Field and Description |
|---|---|
java.lang.Object[] |
buffer
Internal array for storing elements of the deque.
|
int |
head
The index of the element at the head of the deque or an arbitrary number
equal to tail if the deque is empty.
|
protected ArraySizingStrategy |
resizer
Buffer resizing strategy.
|
int |
tail
The index at which the next element would be added to the tail of the
deque.
|
| Constructor and Description |
|---|
ObjectArrayDeque()
New instance with sane defaults.
|
ObjectArrayDeque(int expectedElements)
New instance with sane defaults.
|
ObjectArrayDeque(int expectedElements,
ArraySizingStrategy resizer)
New instance with sane defaults.
|
ObjectArrayDeque(ObjectContainer<? extends KType> container)
Creates a new deque from elements of another container, appending elements at
the end of the deque in the iteration order.
|
| Modifier and Type | Method and Description |
|---|---|
int |
addFirst(java.lang.Iterable<? extends ObjectCursor<? extends KType>> iterable)
Inserts all elements from the given iterable to the front of this deque.
|
void |
addFirst(KType... elements)
Vararg-signature method for adding elements at the front of this deque.
|
void |
addFirst(KType e1)
Inserts the specified element at the front of this deque.
|
int |
addFirst(ObjectContainer<? extends KType> container)
Inserts all elements from the given container to the front of this deque.
|
int |
addLast(java.lang.Iterable<? extends ObjectCursor<? extends KType>> iterable)
Inserts all elements from the given iterable to the end of this deque.
|
void |
addLast(KType... elements)
Vararg-signature method for adding elements at the end of this deque.
|
void |
addLast(KType e1)
Inserts the specified element at the end of this deque.
|
int |
addLast(ObjectContainer<? extends KType> container)
Inserts all elements from the given container to the end of this deque.
|
int |
bufferIndexOf(KType e1)
Return the index of the first (counting from head) element equal to
e1. |
void |
clear()
Removes all elements from this collection.
|
ObjectArrayDeque<KType> |
clone()
Clone this object.
|
boolean |
contains(KType e)
Lookup a given element in the container.
|
private void |
descendingForEach(ObjectPredicate<? super KType> predicate,
int fromIndex,
int toIndex)
Applies
predicate to a slice of the deque,
toIndex, exclusive, down to fromIndex, inclusive
or until the predicate returns false. |
private void |
descendingForEach(ObjectProcedure<? super KType> procedure,
int fromIndex,
int toIndex)
Applies
procedure to a slice of the deque,
toIndex, exclusive, down to fromIndex, inclusive. |
<T extends ObjectPredicate<? super KType>> |
descendingForEach(T predicate)
Applies a
predicate to container elements as long, as the
predicate returns true. |
<T extends ObjectProcedure<? super KType>> |
descendingForEach(T procedure)
Applies
procedure to all elements of this deque, tail to head. |
java.util.Iterator<ObjectCursor<KType>> |
descendingIterator()
Returns a cursor over the values of this deque (in tail to head order).
|
protected void |
ensureBufferSpace(int expectedAdditions)
Ensures the internal buffer has enough free slots to store
expectedAdditions. |
void |
ensureCapacity(int expectedElements)
Ensure this container can hold at least the given number of elements
without resizing its buffers.
|
protected boolean |
equalElements(ObjectArrayDeque<?> other)
Compare order-aligned elements against another
ObjectDeque. |
boolean |
equals(java.lang.Object obj)
Returns
true only if the other object is an instance of
the same class and with the same elements. |
private void |
forEach(ObjectProcedure<? super KType> procedure,
int fromIndex,
int toIndex)
Applies
procedure to a slice of the deque,
fromIndex, inclusive, to toIndex, exclusive. |
<T extends ObjectPredicate<? super KType>> |
forEach(T predicate)
Applies a
predicate to container elements as long, as the
predicate returns true. |
<T extends ObjectProcedure<? super KType>> |
forEach(T procedure)
Applies a
procedure to all container elements. |
static <KType> ObjectArrayDeque<KType> |
from(KType... elements)
Create a new deque by pushing a variable number of arguments to the end of it.
|
KType |
getFirst()
Retrieves the first element of this deque but does not remove it.
|
KType |
getLast()
Retrieves the last element of this deque but does not remove it.
|
int |
hashCode() |
boolean |
isEmpty()
Shortcut for
size() == 0. |
java.util.Iterator<ObjectCursor<KType>> |
iterator()
Returns a cursor over the values of this deque (in head to tail order).
|
int |
lastBufferIndexOf(KType e1)
Return the index of the last (counting from tail) element equal to
e1. |
protected static int |
oneLeft(int index,
int modulus)
Move one index to the left, wrapping around buffer.
|
protected static int |
oneRight(int index,
int modulus)
Move one index to the right, wrapping around buffer.
|
void |
release()
Release internal buffers of this deque and reallocate with the default
buffer.
|
int |
removeAll(KType e1)
Removes all occurrences of
e from this collection. |
int |
removeAll(ObjectPredicate<? super KType> predicate)
Removes all elements in this collection for which the given predicate
returns
true. |
void |
removeAtBufferIndex(int index)
Removes the element at
index in the internal {#link
buffer array, returning its value. |
KType |
removeFirst()
Retrieves and removes the first element of this deque.
|
int |
removeFirst(KType e1)
Removes the first element that equals
e. |
KType |
removeLast()
Retrieves and removes the last element of this deque.
|
int |
removeLast(KType e1)
Removes the last element that equals
e. |
int |
size()
Return the current number of elements in this container.
|
java.lang.Object[] |
toArray()
Default implementation of copying to an array.
|
KType[] |
toArray(KType[] target)
Copies elements of this deque to an array.
|
equals, removeAll, retainAll, retainAll, toArray, toStringfinalize, getClass, notify, notifyAll, wait, wait, waitremoveAll, retainAll, retainAlltoArraypublic java.lang.Object[] buffer
public int head
public int tail
protected final ArraySizingStrategy resizer
public ObjectArrayDeque()
public ObjectArrayDeque(int expectedElements)
expectedElements - The expected number of elements guaranteed not to cause buffer
expansion (inclusive).public ObjectArrayDeque(int expectedElements,
ArraySizingStrategy resizer)
expectedElements - The expected number of elements guaranteed not to cause buffer
expansion (inclusive).resizer - Underlying buffer sizing strategy.public ObjectArrayDeque(ObjectContainer<? extends KType> container)
public void addFirst(KType e1)
addFirst in interface ObjectDeque<KType>@SafeVarargs public final void addFirst(KType... elements)
This method is handy, but costly if used in tight loops (anonymous array passing)
elements - The elements to add.public int addFirst(ObjectContainer<? extends KType> container)
container - The container to iterate over.public int addFirst(java.lang.Iterable<? extends ObjectCursor<? extends KType>> iterable)
iterable - The iterable to iterate over.public void addLast(KType e1)
addLast in interface ObjectDeque<KType>@SafeVarargs public final void addLast(KType... elements)
This method is handy, but costly if used in tight loops (anonymous array passing)
elements - The elements to iterate over.public int addLast(ObjectContainer<? extends KType> container)
container - The container to iterate over.public int addLast(java.lang.Iterable<? extends ObjectCursor<? extends KType>> iterable)
iterable - The iterable to iterate over.public KType removeFirst()
removeFirst in interface ObjectDeque<KType>public KType removeLast()
removeLast in interface ObjectDeque<KType>public KType getFirst()
getFirst in interface ObjectDeque<KType>public KType getLast()
getLast in interface ObjectDeque<KType>public int removeFirst(KType e1)
e.removeFirst in interface ObjectDeque<KType>-1 if the element
was not found.public int bufferIndexOf(KType e1)
e1. The index points to the buffer array.e1 - The element to look for.e1 or
-1 if not found.public int removeLast(KType e1)
e.removeLast in interface ObjectDeque<KType>-1 if the element
was not found.public int lastBufferIndexOf(KType e1)
e1. The index points to the buffer array.e1 - The element to look for.e1 or
-1 if not found.public int removeAll(KType e1)
e from this collection.removeAll in interface ObjectCollection<KType>e1 - Element to be removed from this collection, if present.public void removeAtBufferIndex(int index)
index in the internal {#link
buffer array, returning its value.public boolean isEmpty()
size() == 0.isEmpty in interface ObjectContainer<KType>public int size()
O(n) time, although
implementing classes should try to maintain the current size and return in
constant time.size in interface ObjectContainer<KType>public void clear()
The internal array buffers are not released as a result of this call.
clear in interface ObjectCollection<KType>release()public void release()
release in interface ObjectCollection<KType>ObjectCollection.clear()public void ensureCapacity(int expectedElements)
ensureCapacity in interface PreallocableexpectedElements - The total number of elements, inclusive.protected void ensureBufferSpace(int expectedAdditions)
expectedAdditions. Increases internal buffer size if needed.public java.lang.Object[] toArray()
toArray in interface ObjectContainer<KType>toArray in class AbstractObjectCollection<KType>public KType[] toArray(KType[] target)
target array is filled from index 0 (head of the queue) to
index size() - 1 (tail of the queue).target - The target array must be large enough to hold all elements.public ObjectArrayDeque<KType> clone()
clone in class java.lang.Objectprotected static int oneLeft(int index,
int modulus)
protected static int oneRight(int index,
int modulus)
public java.util.Iterator<ObjectCursor<KType>> iterator()
Iterator.next() (to avoid boxing of
primitive types). To read the current value (or index in the deque's
buffer) use the cursor's public fields. An example is shown below.
for (IntValueCursor c : intDeque) {
System.out.println("buffer index=" + c.index + " value=" + c.value);
}
iterator in interface ObjectContainer<KType>iterator in interface java.lang.Iterable<ObjectCursor<KType>>public java.util.Iterator<ObjectCursor<KType>> descendingIterator()
Iterator.next() (to avoid boxing of
primitive types). To read the current value (or index in the deque's
buffer) use the cursor's public fields. An example is shown below.
for (Iterator<IntCursor> i = intDeque.descendingIterator(); i.hasNext();) {
final IntCursor c = i.next();
System.out.println("buffer index=" + c.index + " value=" + c.value);
}
descendingIterator in interface ObjectDeque<KType>public <T extends ObjectProcedure<? super KType>> T forEach(T procedure)
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 in interface ObjectContainer<KType>private void forEach(ObjectProcedure<? super KType> procedure, int fromIndex, int toIndex)
procedure to a slice of the deque,
fromIndex, inclusive, to toIndex, exclusive.public <T extends ObjectPredicate<? super KType>> T forEach(T predicate)
predicate to container elements as long, as the
predicate returns true. The iteration is interrupted
otherwise.forEach in interface ObjectContainer<KType>public <T extends ObjectProcedure<? super KType>> T descendingForEach(T procedure)
procedure to all elements of this deque, tail to head.descendingForEach in interface ObjectDeque<KType>private void descendingForEach(ObjectProcedure<? super KType> procedure, int fromIndex, int toIndex)
procedure to a slice of the deque,
toIndex, exclusive, down to fromIndex, inclusive.public <T extends ObjectPredicate<? super KType>> T descendingForEach(T predicate)
predicate to container elements as long, as the
predicate returns true. The iteration is interrupted
otherwise.descendingForEach in interface ObjectDeque<KType>private void descendingForEach(ObjectPredicate<? super KType> predicate, int fromIndex, int toIndex)
predicate to a slice of the deque,
toIndex, exclusive, down to fromIndex, inclusive
or until the predicate returns false.public int removeAll(ObjectPredicate<? super KType> predicate)
true.removeAll in interface ObjectCollection<KType>public boolean contains(KType e)
contains in interface ObjectContainer<KType>true if this container has an element equal to
e.public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
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 AbstractObjectCollection.equals(Object, Object)
method.equals in class java.lang.Objectprotected boolean equalElements(ObjectArrayDeque<?> other)
ObjectDeque.
Equality comparison is performed with this object's AbstractObjectCollection.equals(Object, Object)
method.@SafeVarargs public static <KType> ObjectArrayDeque<KType> from(KType... elements)