Package com.carrotsearch.hppc
Class ObjectStack<KType>
java.lang.Object
com.carrotsearch.hppc.AbstractObjectCollection<KType>
com.carrotsearch.hppc.ObjectArrayList<KType>
com.carrotsearch.hppc.ObjectStack<KType>
- All Implemented Interfaces:
ObjectCollection<KType>
,ObjectContainer<KType>
,ObjectIndexedContainer<KType>
,Preallocable
,Cloneable
,Iterable<ObjectCursor<KType>>
,RandomAccess
@Generated(date="2024-02-21T10:44:44+0000",
value="KTypeStack.java")
public class ObjectStack<KType>
extends ObjectArrayList<KType>
A subclass of
ObjectArrayList
adding stack-related utility methods.
The top of the stack is at the ObjectArrayList.size()
- 1
element.-
Nested Class Summary
Nested classes/interfaces inherited from class com.carrotsearch.hppc.ObjectArrayList
ObjectArrayList.ValueIterator<KType>
-
Field Summary
Fields inherited from class com.carrotsearch.hppc.ObjectArrayList
buffer, elementsCount, EMPTY_ARRAY, resizer
-
Constructor Summary
ConstructorsConstructorDescriptionNew instance with sane defaults.ObjectStack
(int expectedElements) New instance with sane defaults.ObjectStack
(int expectedElements, ArraySizingStrategy resizer) New instance with sane defaults.ObjectStack
(ObjectContainer<KType> container) Create a stack by pushing all elements of another container to it. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Clone this object.void
discard()
Discard the top element from the stack.void
discard
(int count) Discard an arbitrary number of elements from the top of the stack.static <KType> ObjectStack
<KType> from
(KType... elements) Create a stack by pushing a variable number of arguments to it.peek()
Peek at the top element on the stack.pop()
Remove the top element from the stack and return it.void
Adds one Object to the stack.final void
Vararg-signature method for pushing elements at the top of the stack.void
Add a range of array elements to the stack.void
Adds two Objects to the stack.void
Adds three Objects to the stack.void
Adds four Objects to the stack.int
pushAll
(ObjectContainer<? extends KType> container) Pushes all elements from another container to the top of the stack.int
pushAll
(Iterable<? extends ObjectCursor<? extends KType>> iterable) Pushes all elements from another iterable to the top of the stack.Methods inherited from class com.carrotsearch.hppc.ObjectArrayList
add, add, add, add, addAll, addAll, clear, contains, ensureBufferSpace, ensureCapacity, equalElements, equals, forEach, forEach, get, hashCode, indexOf, insert, isEmpty, iterator, lastIndexOf, release, remove, removeAll, removeAll, removeFirst, removeLast, removeRange, resize, set, size, toArray, trimToSize
Methods inherited from class com.carrotsearch.hppc.AbstractObjectCollection
equals, removeAll, retainAll, retainAll, toArray, toString
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
Methods inherited from interface com.carrotsearch.hppc.ObjectCollection
removeAll, retainAll, retainAll
Methods inherited from interface com.carrotsearch.hppc.ObjectContainer
toArray
-
Constructor Details
-
ObjectStack
public ObjectStack()New instance with sane defaults. -
ObjectStack
public ObjectStack(int expectedElements) New instance with sane defaults.- Parameters:
expectedElements
- The expected number of elements guaranteed not to cause buffer expansion (inclusive).
-
ObjectStack
New instance with sane defaults.- Parameters:
expectedElements
- The expected number of elements guaranteed not to cause buffer expansion (inclusive).resizer
- Underlying buffer sizing strategy.
-
ObjectStack
Create a stack by pushing all elements of another container to it.
-
-
Method Details
-
push
Adds one Object to the stack. -
push
Adds two Objects to the stack. -
push
Adds three Objects to the stack. -
push
Adds four Objects to the stack. -
push
Add a range of array elements to the stack. -
push
Vararg-signature method for pushing elements at the top of the stack.This method is handy, but costly if used in tight loops (anonymous array passing)
-
pushAll
Pushes all elements from another container to the top of the stack. -
pushAll
Pushes all elements from another iterable to the top of the stack. -
discard
public void discard(int count) Discard an arbitrary number of elements from the top of the stack. -
discard
public void discard()Discard the top element from the stack. -
pop
Remove the top element from the stack and return it. -
peek
Peek at the top element on the stack. -
from
Create a stack by pushing a variable number of arguments to it. -
clone
Clone this object. The returned clone will reuse the same hash function and array resizing strategy.- Overrides:
clone
in classObjectArrayList<KType>
-