Package org.apache.commons.collections4
Class ArrayStack<E>
java.lang.Object
java.util.AbstractCollection<E>
java.util.AbstractList<E>
java.util.ArrayList<E>
org.apache.commons.collections4.ArrayStack<E>
- Type Parameters:
E
- the type of elements in this list
- All Implemented Interfaces:
Serializable
,Cloneable
,Iterable<E>
,Collection<E>
,List<E>
,RandomAccess
Deprecated.
An implementation of the
Stack
API that is based on an
ArrayList
instead of a Vector
, so it is not
synchronized to protect against multithreaded access. The implementation
is therefore operates faster in environments where you do not need to
worry about multiple thread contention.
The removal order of an ArrayStack
is based on insertion
order: The most recently added element is removed first. The iteration
order is not the same as the removal order. The iterator returns
elements from the bottom up.
Unlike Stack
, ArrayStack
accepts null entries.
Note: From version 4.0 onwards, this class does not implement the
removed Buffer
interface anymore.
- Since:
- 1.0
- See Also:
-
Field Summary
Fields inherited from class java.util.AbstractList
modCount
-
Constructor Summary
ConstructorDescriptionDeprecated.Constructs a new emptyArrayStack
.ArrayStack
(int initialSize) Deprecated.Constructs a new emptyArrayStack
with an initial size. -
Method Summary
Modifier and TypeMethodDescriptionboolean
empty()
Deprecated.Returntrue
if this stack is currently empty.peek()
Deprecated.Returns the top item off of this stack without removing it.peek
(int n) Deprecated.Returns the n'th item down (zero-relative) from the top of this stack without removing it.pop()
Deprecated.Pops the top item off of this stack and return it.Deprecated.Pushes a new item onto the top of this stack.int
Deprecated.Returns the one-based position of the distance from the top that the specified object exists on this stack, where the top-most element is considered to be at distance1
.Methods inherited from class java.util.ArrayList
add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize
Methods inherited from class java.util.AbstractList
equals, hashCode
Methods inherited from class java.util.AbstractCollection
containsAll, toString
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Collection
parallelStream, stream
Methods inherited from interface java.util.List
containsAll, equals, hashCode
-
Constructor Details
-
ArrayStack
public ArrayStack()Deprecated.Constructs a new emptyArrayStack
. The initial size is controlled byArrayList
and is currently 10. -
ArrayStack
Deprecated.Constructs a new emptyArrayStack
with an initial size.- Parameters:
initialSize
- the initial size to use- Throws:
IllegalArgumentException
- if the specified initial size is negative
-
-
Method Details
-
empty
Deprecated.Returntrue
if this stack is currently empty.This method exists for compatibility with
Stack
. New users of this class should useisEmpty
instead.- Returns:
- true if the stack is currently empty
-
peek
Deprecated.Returns the top item off of this stack without removing it.- Returns:
- the top item on the stack
- Throws:
EmptyStackException
- if the stack is empty
-
peek
Deprecated.Returns the n'th item down (zero-relative) from the top of this stack without removing it.- Parameters:
n
- the number of items down to go- Returns:
- the n'th item on the stack, zero relative
- Throws:
EmptyStackException
- if there are not enough items on the stack to satisfy this request
-
pop
Deprecated.Pops the top item off of this stack and return it.- Returns:
- the top item on the stack
- Throws:
EmptyStackException
- if the stack is empty
-
push
Deprecated.Pushes a new item onto the top of this stack. The pushed item is also returned. This is equivalent to callingadd
.- Parameters:
item
- the item to be added- Returns:
- the item just pushed
-
search
Deprecated.Returns the one-based position of the distance from the top that the specified object exists on this stack, where the top-most element is considered to be at distance1
. If the object is not present on the stack, return-1
instead. Theequals()
method is used to compare to the items in this stack.- Parameters:
object
- the object to be searched for- Returns:
- the 1-based depth into the stack of the object, or -1 if not found
-
ArrayDeque
instead (available from Java 1.6)