JavaAlgorithms/DataStructures/Stacks/StackArrayList.java

113 lines
2.6 KiB
Java
Raw Normal View History

2020-01-29 00:18:15 +08:00
package DataStructures.Stacks;
import java.util.ArrayList;
2020-09-14 20:18:54 +08:00
import java.util.EmptyStackException;
/**
* This class implements a Stack using an ArrayList.
2019-01-06 09:01:33 +08:00
* <p>
* A stack is exactly what it sounds like. An element gets added to the top of
* the stack and only the element on the top may be removed.
2019-01-06 09:01:33 +08:00
* <p>
* This is an ArrayList Implementation of a stack, where size is not
* a problem we can extend the stack as much as we want.
*/
2019-01-06 09:01:33 +08:00
public class StackArrayList {
2019-01-06 09:01:33 +08:00
/**
2020-09-14 20:18:54 +08:00
* Driver Code
2019-01-06 09:01:33 +08:00
*/
public static void main(String[] args) {
2020-09-14 20:18:54 +08:00
StackArrayList stack = new StackArrayList();
assert stack.isEmpty();
for (int i = 1; i <= 5; ++i) {
stack.push(i);
assert stack.size() == i;
}
assert stack.size() == 5;
assert stack.peek() == 5 && stack.pop() == 5 && stack.peek() == 4;
/* pop elements at the top of this stack one by one */
while (!stack.isEmpty()) {
stack.pop();
}
assert stack.isEmpty();
try {
stack.pop();
assert false; /* this should not happen */
} catch (EmptyStackException e) {
assert true; /* this should happen */
}
2019-01-06 09:01:33 +08:00
}
2019-01-06 09:01:33 +08:00
/**
* ArrayList representation of the stack
*/
2020-09-14 20:18:54 +08:00
private ArrayList<Integer> stack;
2019-01-06 09:01:33 +08:00
/**
* Constructor
*/
public StackArrayList() {
2020-09-14 20:18:54 +08:00
stack = new ArrayList<>();
2019-01-06 09:01:33 +08:00
}
2019-01-06 09:01:33 +08:00
/**
* Adds value to the end of list which
* is the top for stack
*
* @param value value to be added
*/
public void push(int value) {
2020-09-14 20:18:54 +08:00
stack.add(value);
2019-01-06 09:01:33 +08:00
}
2019-01-06 09:01:33 +08:00
/**
2020-09-14 20:18:54 +08:00
* Removes the element at the top of this stack and returns
2019-01-06 09:01:33 +08:00
*
* @return Element popped
2020-09-14 20:18:54 +08:00
* @throws EmptyStackException if the stack is empty.
2019-01-06 09:01:33 +08:00
*/
public int pop() {
2020-09-14 20:18:54 +08:00
if (isEmpty()) {
throw new EmptyStackException();
2019-01-06 09:01:33 +08:00
}
2020-09-14 20:18:54 +08:00
/* remove the element on the top of the stack */
return stack.remove(stack.size() - 1);
}
2019-01-06 09:01:33 +08:00
/**
2020-09-14 20:18:54 +08:00
* Test if the stack is empty.
2019-01-06 09:01:33 +08:00
*
2020-09-14 20:18:54 +08:00
* @return {@code true} if this stack is empty, {@code false} otherwise.
2019-01-06 09:01:33 +08:00
*/
public boolean isEmpty() {
2020-09-14 20:18:54 +08:00
return stack.isEmpty();
2019-01-06 09:01:33 +08:00
}
2019-01-06 09:01:33 +08:00
/**
2020-09-14 20:18:54 +08:00
* Return the element at the top of this stack without removing it from the stack.
2019-01-06 09:01:33 +08:00
*
2020-09-14 20:18:54 +08:00
* @return the element at the top of this stack.
2019-01-06 09:01:33 +08:00
*/
public int peek() {
2020-09-14 20:18:54 +08:00
if (isEmpty()) {
throw new EmptyStackException();
}
return stack.get(stack.size() - 1);
}
/**
* Return size of this stack.
*
* @return size of this stack.
*/
public int size() {
return stack.size();
2019-01-06 09:01:33 +08:00
}
2020-09-14 20:18:54 +08:00
}