io.nem.symbol.core.utils

Class CircularStack<E>

java.lang.Object

io.nem.symbol.core.utils.CircularStack<E>

Type Parameters:

E - Type of elements on the stack.

All Implemented Interfaces:

java.lang.Iterable<E>

public class CircularStack<E>
extends java.lang.Object
implements java.lang.Iterable<E>

Circular stack is a last in first out buffer with fixed size that replace its oldest element if full. The removal order is inverse of insertion order. The iteration order is the same as insertion order. Note that implementation is not synchronized.

Constructor Summary

Constructors

Constructor and Description
CircularStack(int limit) Creates circular stack with at most limit elements.

Method Summary

Modifier and Type	Method and Description
java.util.Iterator<E>	iterator()
E	peek() Gets most recently added element.
void	pop() Removes most recently added element.
void	push(E element) Adds element to the stack.
void	shallowCopyTo(CircularStack<E> destination) Creates shallow copy in destination.
int	size() Returns size of a stack.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CircularStack

public CircularStack(int limit)

Creates circular stack with at most limit elements.

Parameters:

limit - Maximum number of elements on the stack.

Method Detail

shallowCopyTo

public void shallowCopyTo(CircularStack<E> destination)

Creates shallow copy in destination.

Parameters:

destination - CircularStack to which elements should be copied.

push

public void push(E element)

Adds element to the stack.

Parameters:

element - Element to be added.

peek

public E peek()

Gets most recently added element.

Returns:

Most recently added element.

pop

public void pop()

Removes most recently added element.

size

public int size()

Returns size of a stack.

Returns:

Size of a stack (can be smaller than limit).

iterator

public java.util.Iterator<E> iterator()

Specified by:

iterator in interface java.lang.Iterable<E>