Top Description Fields Constructors Methods
com.carrotsearch.hppc

public Class ObjectStack<KType>

extends ObjectArrayList<KType>
Class Inheritance
Annotations
@SuppressWarnings:unchecked
@Generated:KTypeStack.java
date:2024-06-04T15:20:17+0200
Imports
com.carrotsearch.hppc.cursors.ObjectCursor, java.util.Arrays
A subclass of ObjectArrayList adding stack-related utility methods. The top of the stack is at the size() - 1 element.

Field Summary

Inherited from com.carrotsearch.hppc.ObjectArrayList:
bufferelementsCountEMPTY_ARRAYresizer

Constructor Summary

AccessConstructor and Description
public
ObjectStack()

New instance with sane defaults.

public
ObjectStack(int
The expected number of elements guaranteed not to cause buffer expansion (inclusive).
expectedElements)

New instance with sane defaults.

public
ObjectStack(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
ObjectStack(ObjectContainer<KType> container)

Create a stack by pushing all elements of another container to it.

Method Summary

Modifier and TypeMethod and Description
public ObjectStack<KType>
clone()

Overrides com.carrotsearch.hppc.ObjectArrayList.clone.

Clone this object.

public void
discard(int count)

Discard an arbitrary number of elements from the top of the stack.

public void
discard()

Discard the top element from the stack.

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

Hides com.carrotsearch.hppc.ObjectArrayList.from.

Create a stack by pushing a variable number of arguments to it.

public KType
peek()

Peek at the top element on the stack.

public KType
pop()

Remove the top element from the stack and return it.

public void
push(KType e1)

Adds one Object to the stack.

public void
push(KType e1, KType e2)

Adds two Objects to the stack.

public void
push(KType e1, KType e2, KType e3)

Adds three Objects to the stack.

public void
push(KType e1, KType e2, KType e3, KType e4)

Adds four Objects to the stack.

public void
push(KType[] elements, int start, int len)

Add a range of array elements to the stack.

public final void
push(KType... elements)

Vararg-signature method for pushing elements at the top of the stack.

public int
pushAll(ObjectContainer<? extends KType> container)

Pushes all elements from another container to the top of the stack.

public int
pushAll(Iterable<? extends ObjectCursor<? extends KType>> iterable)

Pushes all elements from another iterable to the top of the stack.

Inherited from com.carrotsearch.hppc.ObjectArrayList:
addaddaddaddaddAlladdAllclearcontainsensureBufferSpaceensureCapacityequalElementsequalsforEachforEachforEachforEachgethashCodeindexOfinsertisEmptyiteratorlastIndexOframBytesAllocatedramBytesUsedreleaseremoveAllremoveAllremoveAtremoveElementremoveFirstremoveLastremoveLastremoveRangeresizereversesetsizesortstreamtoArraytrimToSize

Constructor Detail

ObjectStackback to summary
public ObjectStack()

New instance with sane defaults.

ObjectStackback to summary
public ObjectStack(int expectedElements)

New instance with sane defaults.

Parameters
expectedElements:int

The expected number of elements guaranteed not to cause buffer expansion (inclusive).

ObjectStackback to summary
public ObjectStack(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.

ObjectStackback to summary
public ObjectStack(ObjectContainer<KType> container)

Create a stack by pushing all elements of another container to it.

Method Detail

cloneback to summary
public ObjectStack<KType> clone()

Overrides com.carrotsearch.hppc.ObjectArrayList.clone.

Doc from com.carrotsearch.hppc.ObjectArrayList.clone.

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

Returns:ObjectStack<KType>

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations
@Override
discardback to summary
public void discard(int count)

Discard an arbitrary number of elements from the top of the stack.

discardback to summary
public void discard()

Discard the top element from the stack.

fromback to summary
public static <KType> ObjectStack<KType> from(KType... elements)

Hides com.carrotsearch.hppc.ObjectArrayList.from.

Create a stack by pushing a variable number of arguments to it.

Annotations
@SafeVarargs
peekback to summary
public KType peek()

Peek at the top element on the stack.

popback to summary
public KType pop()

Remove the top element from the stack and return it.

pushback to summary
public void push(KType e1)

Adds one Object to the stack.

pushback to summary
public void push(KType e1, KType e2)

Adds two Objects to the stack.

pushback to summary
public void push(KType e1, KType e2, KType e3)

Adds three Objects to the stack.

pushback to summary
public void push(KType e1, KType e2, KType e3, KType e4)

Adds four Objects to the stack.

pushback to summary
public void push(KType[] elements, int start, int len)

Add a range of array elements to the stack.

pushback to summary
public final void push(KType... elements)

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)

Annotations
@SafeVarargs
pushAllback to summary
public int pushAll(ObjectContainer<? extends KType> container)

Pushes all elements from another container to the top of the stack.

pushAllback to summary
public int pushAll(Iterable<? extends ObjectCursor<? extends KType>> iterable)

Pushes all elements from another iterable to the top of the stack.