com.github.fge.grappa.stack

Class DefaultValueStack<V>

java.lang.Object

com.github.fge.grappa.stack.ValueStackBase<V>

com.github.fge.grappa.stack.DefaultValueStack<V>

All Implemented Interfaces:

ValueStack<V>, Iterable<V>

@ParametersAreNonnullByDefault
public final class DefaultValueStack<V>
extends ValueStackBase<V>

Constructor Summary

Constructors

Constructor and Description
DefaultValueStack()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkIndex(int index)
void	clear() Clears all values.
protected void	doDup()
protected V	doPeek(int down) Retrieves, witout removing, the value at the given stack indx
protected void	doPoke(int down, V value) Replaces a value at a given stack index
protected V	doPop(int down) Removes the value from a given stack index
protected void	doPush(int down, V value) Push a value onto the stack at the given index
protected void	doSwap(int n) Reverses the order of the top n stack values
boolean	isEmpty() Determines whether the stack is empty.
Iterator<V>	iterator()
void	restoreSnapshot(Object snapshot) Restores the stack state as previously returned by ValueStack.takeSnapshot().
int	size() Returns the number of elements currently on the stack.
Object	takeSnapshot() Returns an object representing the current state of the stack.
String	toString()

Methods inherited from class com.github.fge.grappa.stack.ValueStackBase

dup, peek, peek, peekAs, peekAs, poke, poke, pop, pop, popAs, popAs, push, push, swap, swap

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultValueStack

public DefaultValueStack()

Method Detail

isEmpty

public boolean isEmpty()

Description copied from interface: ValueStack

Determines whether the stack is empty.

Returns:

true if empty

size

public int size()

Description copied from interface: ValueStack

Returns the number of elements currently on the stack.

Returns:

the number of elements

clear

public void clear()

Description copied from interface: ValueStack

Clears all values.

takeSnapshot

@Nonnull
public Object takeSnapshot()

Description copied from interface: ValueStack

Returns an object representing the current state of the stack.

Returns:

an object representing the current state of the stack

restoreSnapshot

public void restoreSnapshot(Object snapshot)

Description copied from interface: ValueStack

Restores the stack state as previously returned by ValueStack.takeSnapshot().

Parameters:

snapshot - a snapshot object previously returned by ValueStack.takeSnapshot()

doPush

protected void doPush(int down,
          V value)

Description copied from class: ValueStackBase

Push a value onto the stack at the given index

The value is guaranteed never to be null and the index is guaranteed to be valid.

Specified by:

doPush in class ValueStackBase<V>

Parameters:

down - the index

value - the value

doPop

@Nonnull
protected V doPop(int down)

Description copied from class: ValueStackBase

Removes the value from a given stack index

The index is guaranteed to be valid.

Specified by:

doPop in class ValueStackBase<V>

Parameters:

down - the index

Returns:

the value

doPeek

@Nonnull
protected V doPeek(int down)

Description copied from class: ValueStackBase

Retrieves, witout removing, the value at the given stack indx

The index is guaranteed to be valid.

Specified by:

doPeek in class ValueStackBase<V>

Parameters:

down - the index

Returns:

the value

doPoke

protected void doPoke(int down,
          V value)

Description copied from class: ValueStackBase

Replaces a value at a given stack index

The index is guaranteed to be valid and the value is guaranteed not to be null.

Specified by:

doPoke in class ValueStackBase<V>

Parameters:

down - the index

value - the value

doDup

protected void doDup()

Specified by:

doDup in class ValueStackBase<V>

doSwap

protected void doSwap(int n)

Description copied from class: ValueStackBase

Reverses the order of the top n stack values

The number of values is guaranteed to be valid.

Specified by:

doSwap in class ValueStackBase<V>

Parameters:

n - the number of values to swap

iterator

public Iterator<V> iterator()

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

checkIndex

protected void checkIndex(int index)

Specified by:

checkIndex in class ValueStackBase<V>