ValueStackBase (grappa 2.0.4-SNAPSHOT API)

java.lang.Object
- com.github.fge.grappa.stack.ValueStackBase<V>

Type Parameters:
V - type parameter of this stack's values

All Implemented Interfaces:

ValueStack<V>, Iterable<V>

Direct Known Subclasses:

DefaultValueStack
```
@ParametersAreNonnullByDefault
public abstract class ValueStackBase<V>
extends Object
implements ValueStack<V>
```
Base abstract implementation of a ValueStack

Constructor Summary

Constructors
Constructor and Description

ValueStackBase()

Constructors
Constructor and Description
`ValueStackBase()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected abstract void`	`checkIndex(int index)`
`protected abstract void`	`doDup()`
`protected abstract V`	`doPeek(int down)` Retrieves, witout removing, the value at the given stack indx
`protected abstract void`	`doPoke(int down, V value)` Replaces a value at a given stack index
`protected abstract V`	`doPop(int down)` Removes the value from a given stack index
`protected abstract void`	`doPush(int down, V value)` Push a value onto the stack at the given index
`protected abstract void`	`doSwap(int n)` Reverses the order of the top n stack values
`void`	`dup()` Duplicates the top value.
`V`	`peek()` Returns the value at the top of the stack without removing it.
`V`	`peek(int down)` Returns the value the given number of elements below the top of the stack without removing it.
`<T extends V> T`	`peekAs(Class<T> type)` Casts and returns the value at the top of the stack without removing it
`<T extends V> T`	`peekAs(Class<T> type, int down)` Casts and returns the value at a given index in the stack without removing it
`void`	`poke(int down, V value)` Replaces the element the given number of elements below the current top of the stack.
`void`	`poke(V value)` Replaces the current top value with the given value.
`V`	`pop()` Removes the value at the top of the stack and returns it.
`V`	`pop(int down)` Removes the value the given number of elements below the top of the stack.
`<T extends V> T`	`popAs(Class<T> type)` Removes and casts the value at the top of the stack, and returns it
`<T extends V> T`	`popAs(Class<T> type, int down)` Removes and casts the value at a given index in the stack, and returns it
`void`	`push(int down, V value)` Inserts the given value a given number of elements below the current top of the stack.
`void`	`push(V value)` Pushes the given value onto the stack.
`void`	`swap()` Swaps the top two stack values.
`void`	`swap(int n)` Reverses the order of the top n stack values

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.github.fge.grappa.stack.ValueStack
clear, isEmpty, restoreSnapshot, size, takeSnapshot

Methods inherited from interface java.lang.Iterable
iterator

- Constructor Detail
  - ValueStackBase
```
public ValueStackBase()
```
- Method Detail
  - push
```
public final void push(V value)
```
    Description copied from interface: ValueStack
    
    Pushes the given value onto the stack. Equivalent to push(0, value).
    
    Specified by:
    
    push in interface ValueStack<V>
    
    Parameters:
    value - the value
  - push
```
public final void push(int down,
        V value)
```
    Description copied from interface: ValueStack
    
    Inserts the given value a given number of elements below the current top of the stack.
    
    Specified by:
    
    push in interface ValueStack<V>
    
    Parameters:
    down - the number of elements to skip before inserting the value (0 being equivalent to push(value))
    value - the value
  - doPush
```
protected abstract void doPush(int down,
          V value)
```
    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.
    
    Parameters:
    down - the index
    value - the value
  - pop
```
@Nonnull
public final V pop()
```
    Description copied from interface: ValueStack
    
    Removes the value at the top of the stack and returns it.
    
    Specified by:
    
    pop in interface ValueStack<V>
    
    Returns:
    the current top value
  - pop
```
@Nonnull
public final V pop(int down)
```
    Description copied from interface: ValueStack
    
    Removes the value the given number of elements below the top of the stack.
    
    Specified by:
    
    pop in interface ValueStack<V>
    
    Parameters:
    down - the number of elements to skip before removing the value (0 being equivalent to pop())
    
    Returns:
    the value
  - popAs
```
@Nonnull
public final <T extends V> T popAs(Class<T> type)
```
    Description copied from interface: ValueStack
    
    Removes and casts the value at the top of the stack, and returns it
    
    Specified by:
    
    popAs in interface ValueStack<V>
    
    Type Parameters:
    T - type parameter
    Parameters:
    type - the type to cast to
    
    Returns:
    the value
  - popAs
```
@Nonnull
public final <T extends V> T popAs(Class<T> type,
                            int down)
```
    Description copied from interface: ValueStack
    
    Removes and casts the value at a given index in the stack, and returns it
    
    Specified by:
    
    popAs in interface ValueStack<V>
    
    Type Parameters:
    T - type parameter
    Parameters:
    type - the type to cast to
    down - the index
    
    Returns:
    the value
  - doPop
```
protected abstract V doPop(int down)
```
    Removes the value from a given stack index
    The index is guaranteed to be valid.
    
    Parameters:
    down - the index
    
    Returns:
    the value
  - peek
```
@Nonnull
public final V peek()
```
    Description copied from interface: ValueStack
    
    Returns the value at the top of the stack without removing it.
    
    Specified by:
    
    peek in interface ValueStack<V>
    
    Returns:
    the current top value
  - peek
```
@Nonnull
public final V peek(int down)
```
    Description copied from interface: ValueStack
    
    Returns the value the given number of elements below the top of the stack without removing it.
    
    Specified by:
    
    peek in interface ValueStack<V>
    
    Parameters:
    down - the number of elements to skip (0 being equivalent to peek())
    
    Returns:
    the value
  - peekAs
```
@Nonnull
public final <T extends V> T peekAs(Class<T> type)
```
    Description copied from interface: ValueStack
    
    Casts and returns the value at the top of the stack without removing it
    
    Specified by:
    
    peekAs in interface ValueStack<V>
    
    Type Parameters:
    T - type parameter
    Parameters:
    type - the type to cast to
    
    Returns:
    the value
  - peekAs
```
@Nonnull
public final <T extends V> T peekAs(Class<T> type,
                             int down)
```
    Description copied from interface: ValueStack
    
    Casts and returns the value at a given index in the stack without removing it
    
    Specified by:
    
    peekAs in interface ValueStack<V>
    
    Type Parameters:
    T - type parameter
    Parameters:
    type - the type to cast to
    down - the index in the stack
    
    Returns:
    the value
  - doPeek
```
protected abstract V doPeek(int down)
```
    Retrieves, witout removing, the value at the given stack indx
    The index is guaranteed to be valid.
    
    Parameters:
    down - the index
    
    Returns:
    the value
  - poke
```
public final void poke(@Nonnull
        V value)
```
    Description copied from interface: ValueStack
    
    Replaces the current top value with the given value. Equivalent to poke(0, value).
    
    Specified by:
    
    poke in interface ValueStack<V>
    
    Parameters:
    value - the value
  - poke
```
public final void poke(int down,
        V value)
```
    Description copied from interface: ValueStack
    
    Replaces the element the given number of elements below the current top of the stack.
    
    Specified by:
    
    poke in interface ValueStack<V>
    
    Parameters:
    down - the number of elements to skip before replacing the value (0 being equivalent to poke(value))
    value - the value to replace with
  - doPoke
```
protected abstract void doPoke(int down,
          V value)
```
    Replaces a value at a given stack index
    The index is guaranteed to be valid and the value is guaranteed not to be null.
    
    Parameters:
    down - the index
    value - the value
  - swap
```
public final void swap(int n)
```
    Description copied from interface: ValueStack
    
    Reverses the order of the top n stack values
    
    Specified by:
    
    swap in interface ValueStack<V>
    
    Parameters:
    n - the number of elements to reverse
  - swap
```
public final void swap()
```
    Description copied from interface: ValueStack
    
    Swaps the top two stack values.
    
    Specified by:
    
    swap in interface ValueStack<V>
  - dup
```
public final void dup()
```
    Duplicates the top value. Equivalent to push(peek()).
    
    Specified by:
    
    dup in interface ValueStack<V>
  - doDup
```
protected abstract void doDup()
```
  - doSwap
```
protected abstract void doSwap(int n)
```
    Reverses the order of the top n stack values
    The number of values is guaranteed to be valid.
    
    Parameters:
    n - the number of values to swap
  - checkIndex
```
protected abstract void checkIndex(int index)
```

Class ValueStackBase<V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.github.fge.grappa.stack.ValueStack

Methods inherited from interface java.lang.Iterable

Constructor Detail

ValueStackBase

Method Detail

push

push

doPush

pop

pop

popAs

popAs

doPop

peek

peek

peekAs

peekAs

doPeek

poke

poke

doPoke

swap

swap

dup

doDup

doSwap

checkIndex