SimpleStackNullSupport (spf4j-slf4j-test 8.9.3-SNAPSHOT API)

java.lang.Object
- org.spf4j.ds.SimpleStackNullSupport<T>

Type Parameters:

T -

All Implemented Interfaces:

Iterable<T>, Collection<T>, List<T>

Direct Known Subclasses:

SimpleStack
```
@ParametersAreNullableByDefault
public class SimpleStackNullSupport<T>
extends Object
implements List<T>
```
A simple stack implementation that supports null elements.

Author:

Zoltan Farkas

Constructor Summary

Constructors
Constructor and Description

SimpleStackNullSupport()
Construct a stack, default size is 20

SimpleStackNullSupport(int size)
construct a stack with specified size

Constructors
Constructor and Description
`SimpleStackNullSupport()` Construct a stack, default size is 20
`SimpleStackNullSupport(int size)` construct a stack with specified size

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(int index, T element)` Not implemented, can be overwritten.
`boolean`	`add(T e)`
`boolean`	`addAll(Collection<? extends T> c)` Not implemented, can be overwritten.
`boolean`	`addAll(int index, Collection<? extends T> c)` Not implemented, can be overwritten.
`void`	`clear()` Clear the stack - also makes sure the stack objects are not referenced anymore
`boolean`	`contains(Object o)` can be overwritten to optimize.
`boolean`	`containsAll(Collection<?> c)` Not implemented, can be overwritten.
`boolean`	`equals(Object obj)`
`T`	`get(int index)`
`T`	`getFromPtr(int ptr)` get element from stack at index relative to base
`int`	`getPtr()` get the curent stack pos relative to base
`boolean`	`hasElements()`
`int`	`hashCode()` can be overwritten for better implementation.
`int`	`indexOf(Object o)` Not implemented, can be overwritten.
`boolean`	`isEmpty()` check if stack is empty
`Iterator<T>`	`iterator()` Not implemented, can be overwritten.
`int`	`lastIndexOf(Object o)` Not implemented, can be overwritten.
`ListIterator<T>`	`listIterator()` Not implemented, can be overwritten.
`ListIterator<T>`	`listIterator(int index)` Not implemented, can be overwritten.
`T`	`peek()` take a look at the top of stack.
`T[]`	`peek(int n)`
`T`	`peekElemAfter(T until)`
`T`	`peekFromTop(int n)`
`T[]`	`peekUntil(T until)`
`T`	`pop()` pops object out of stack
`T[]`	`pop(int n)`
`void`	`popTo(T[] to, int n)`
`T[]`	`popUntil(T until)`
`void`	`push(T o)` push object into stack
`void`	`pushAll(T... args)` Push more objects into the stack
`int`	`pushAndGetIdx(T o)`
`void`	`pushNull()` pushes a null on top of stack.
`void`	`remove()`
`T`	`remove(int index)`
`boolean`	`remove(Object o)` Can be overwritten for better implementation.
`boolean`	`removeAll(Collection<?> c)` Not implemented, can be overwritten.
`void`	`removeFromTop(int n)`
`void`	`replaceFromTop(int n, T value)`
`boolean`	`retainAll(Collection<?> c)` Not implemented, can be overwritten.
`T`	`set(int index, T element)`
`int`	`size()`
`List<T>`	`subList(int fromIndex, int toIndex)` Not implemented, can be overwritten.
`Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] a)` Not implemented, can be overwritten.
`String`	`toString()` to string representation.
`String`	`toString(char separator)` returns a character separated string with the stack elements

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

Methods inherited from interface java.util.List
replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - SimpleStackNullSupport
```
public SimpleStackNullSupport(int size)
```
    construct a stack with specified size
  - SimpleStackNullSupport
```
public SimpleStackNullSupport()
```
    Construct a stack, default size is 20
- Method Detail
  - isEmpty
```
public final boolean isEmpty()
```
    check if stack is empty
    
    Specified by:
    
    isEmpty in interface Collection<T>
    
    Specified by:
    
    isEmpty in interface List<T>
    
    Returns:
    
    boolean
  - push
```
public final void push(T o)
```
    push object into stack
    
    Parameters:
    
    o - Object
  - pushNull
```
public void pushNull()
```
    pushes a null on top of stack. cane be overridden to prohibit operation.
  - pushAndGetIdx
```
public final int pushAndGetIdx(T o)
```
  - pushAll
```
public final void pushAll(T... args)
```
    Push more objects into the stack
    
    Parameters:
    
    args -
  - pop
```
public final T pop()
```
    pops object out of stack
    
    Returns:
    
    Object
  - remove
```
public final void remove()
```
  - pop
```
public final T[] pop(int n)
```
  - popTo
```
public final void popTo(T[] to,
                        int n)
```
  - removeFromTop
```
public final void removeFromTop(int n)
```
  - popUntil
```
public final T[] popUntil(T until)
```
  - hasElements
```
public final boolean hasElements()
```
  - peek
```
public T peek()
```
    take a look at the top of stack. Throws exception if there is no element.
    
    Returns:
    
    Object
  - peekFromTop
```
public final T peekFromTop(int n)
```
  - replaceFromTop
```
public final void replaceFromTop(int n,
                                 T value)
```
  - peek
```
public final T[] peek(int n)
```
  - peekUntil
```
public final T[] peekUntil(T until)
```
  - peekElemAfter
```
public final T peekElemAfter(T until)
```
  - clear
```
public final void clear()
```
    Clear the stack - also makes sure the stack objects are not referenced anymore
    
    Specified by:
    
    clear in interface Collection<T>
    
    Specified by:
    
    clear in interface List<T>
  - getPtr
```
public final int getPtr()
```
    get the curent stack pos relative to base
    
    Returns:
  - getFromPtr
```
public final T getFromPtr(int ptr)
```
    get element from stack at index relative to base
    
    Parameters:
    
    ptr -
    
    Returns:
  - toString
```
public final String toString(char separator)
```
    returns a character separated string with the stack elements
    
    Parameters:
    
    separator -
    
    Returns:
    
    String
  - toString
```
public String toString()
```
    to string representation. can be subclassed.
    
    Overrides:
    
    toString in class Object
  - size
```
public final int size()
```
    Specified by:
    
    size in interface Collection<T>
    
    Specified by:
    
    size in interface List<T>
  - contains
```
public boolean contains(Object o)
```
    can be overwritten to optimize.
    
    Specified by:
    
    contains in interface Collection<T>
    
    Specified by:
    
    contains in interface List<T>
  - iterator
```
public Iterator<T> iterator()
```
    Not implemented, can be overwritten.
    
    Specified by:
    
    iterator in interface Iterable<T>
    
    Specified by:
    
    iterator in interface Collection<T>
    
    Specified by:
    
    iterator in interface List<T>
  - toArray
```
public final Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<T>
    
    Specified by:
    
    toArray in interface List<T>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Not implemented, can be overwritten.
    
    Specified by:
    
    toArray in interface Collection<T>
    
    Specified by:
    
    toArray in interface List<T>
  - add
```
public final boolean add(T e)
```
    Specified by:
    
    add in interface Collection<T>
    
    Specified by:
    
    add in interface List<T>
  - remove
```
public boolean remove(Object o)
```
    Can be overwritten for better implementation.
    
    Specified by:
    
    remove in interface Collection<T>
    
    Specified by:
    
    remove in interface List<T>
    
    Parameters:
    
    o - element to remove.
    
    Returns:
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Not implemented, can be overwritten.
    
    Specified by:
    
    containsAll in interface Collection<T>
    
    Specified by:
    
    containsAll in interface List<T>
  - addAll
```
public boolean addAll(Collection<? extends T> c)
```
    Not implemented, can be overwritten.
    
    Specified by:
    
    addAll in interface Collection<T>
    
    Specified by:
    
    addAll in interface List<T>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Not implemented, can be overwritten.
    
    Specified by:
    
    removeAll in interface Collection<T>
    
    Specified by:
    
    removeAll in interface List<T>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Not implemented, can be overwritten.
    
    Specified by:
    
    retainAll in interface Collection<T>
    
    Specified by:
    
    retainAll in interface List<T>
  - equals
```
public final boolean equals(Object obj)
```
    Specified by:
    
    equals in interface Collection<T>
    
    Specified by:
    
    equals in interface List<T>
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    can be overwritten for better implementation.
    
    Specified by:
    
    hashCode in interface Collection<T>
    
    Specified by:
    
    hashCode in interface List<T>
    
    Overrides:
    
    hashCode in class Object
  - addAll
```
public boolean addAll(int index,
                      Collection<? extends T> c)
```
    Not implemented, can be overwritten.
    
    Specified by:
    
    addAll in interface List<T>
  - get
```
public final T get(int index)
```
    Specified by:
    
    get in interface List<T>
  - set
```
public final T set(int index,
                   T element)
```
    Specified by:
    
    set in interface List<T>
  - add
```
public void add(int index,
                T element)
```
    Not implemented, can be overwritten.
    
    Specified by:
    
    add in interface List<T>
  - remove
```
public final T remove(int index)
```
    Specified by:
    
    remove in interface List<T>
  - indexOf
```
public int indexOf(Object o)
```
    Not implemented, can be overwritten.
    
    Specified by:
    
    indexOf in interface List<T>
  - lastIndexOf
```
public int lastIndexOf(Object o)
```
    Not implemented, can be overwritten.
    
    Specified by:
    
    lastIndexOf in interface List<T>
  - listIterator
```
public ListIterator<T> listIterator()
```
    Not implemented, can be overwritten.
    
    Specified by:
    
    listIterator in interface List<T>
  - listIterator
```
public ListIterator<T> listIterator(int index)
```
    Not implemented, can be overwritten.
    
    Specified by:
    
    listIterator in interface List<T>
  - subList
```
public List<T> subList(int fromIndex,
                       int toIndex)
```
    Not implemented, can be overwritten.
    
    Specified by:
    
    subList in interface List<T>

Class SimpleStackNullSupport<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

SimpleStackNullSupport

SimpleStackNullSupport

Method Detail

isEmpty

push

pushNull

pushAndGetIdx

pushAll

pop

remove

pop

popTo

removeFromTop

popUntil

hasElements

peek

peekFromTop

replaceFromTop

peek

peekUntil

peekElemAfter

clear

getPtr

getFromPtr

toString

toString

size

contains

iterator

toArray

toArray

add

remove

containsAll

addAll

removeAll

retainAll

equals

hashCode

addAll

get

set

add

remove

indexOf

lastIndexOf

listIterator

listIterator

subList