Class ConsPStack<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.AbstractSequentialList<E>

org.pcollections.AbstractUnmodifiableSequentialList<E>

org.pcollections.ConsPStack<E>

Type Parameters:

E -

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, List<E>, PCollection<E>, PSequence<E>, PStack<E>

public final class ConsPStack<E>
extends AbstractUnmodifiableSequentialList<E>
implements PStack<E>, Serializable

A simple persistent stack.

This implementation is thread-safe (assuming Java's AbstractSequentialList is thread-safe), although its iterators may not be.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private static final ConsPStack<Object>	EMPTY	/ STATIC FACTORY METHODS ////
private final E	first	/ PRIVATE CONSTRUCTORS ////
private final ConsPStack<E>	rest
private static final long	serialVersionUID
private final int	size

Fields inherited from class AbstractList

modCount

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ConsPStack()
private	ConsPStack(E first, ConsPStack<E> rest)

Method Summary

Modifier and Type	Method	Description
static <E> ConsPStack<E>	empty()
static <E> ConsPStack<E>	from(Collection<? extends E> list)
private static <E> ConsPStack<E>	from(Iterator<? extends E> i)
ListIterator<E>	listIterator(int index)
ConsPStack<E>	minus(int i)
ConsPStack<E>	minus(Object e)	Returns a sequence consisting of the elements of this without the first occurrence of e.
ConsPStack<E>	minusAll(Collection<?> list)
ConsPStack<E>	plus(int i, E e)
ConsPStack<E>	plus(E e)	/ IMPLEMENTED METHODS OF PStack ////
ConsPStack<E>	plusAll(int i, Collection<? extends E> list)
ConsPStack<E>	plusAll(Collection<? extends E> list)	Returns a stack consisting of the elements of this with list prepended in reverse.
static <E> ConsPStack<E>	singleton(E e)
int	size()	/ REQUIRED METHODS FROM AbstractSequentialList ////
ConsPStack<E>	subList(int start)
ConsPStack<E>	subList(int start, int end)	/ OVERRIDDEN METHODS FROM AbstractSequentialList ////
ConsPStack<E>	with(int i, E e)

Methods inherited from class AbstractUnmodifiableSequentialList

add, add, addAll, addAll, clear, remove, remove, removeAll, removeIf, replaceAll, retainAll, set, sort

Methods inherited from class AbstractSequentialList

get, iterator

Methods inherited from class AbstractList

equals, hashCode, indexOf, lastIndexOf, listIterator, removeRange

Methods inherited from class AbstractCollection

contains, containsAll, isEmpty, toArray, toArray, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface Iterable

forEach

Methods inherited from interface List

add, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface PCollection

add, addAll, clear, remove, removeAll, retainAll

Methods inherited from interface PSequence

add, addAll, remove, set

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

EMPTY

private static final ConsPStack<Object> EMPTY

/ STATIC FACTORY METHODS ////

first

private final E first

/ PRIVATE CONSTRUCTORS ////

rest

private final ConsPStack<E> rest

size

private final int size

Constructor Details

ConsPStack

private ConsPStack()

ConsPStack

private ConsPStack(E first,
 ConsPStack<E> rest)

Method Details

empty

public static <E> ConsPStack<E> empty()

Type Parameters:

E -

Returns:

an empty stack

singleton

public static <E> ConsPStack<E> singleton(E e)

Type Parameters:

E -

Parameters:

e -

Returns:

empty().plus(e)

from

public static <E> ConsPStack<E> from(Collection<? extends E> list)

Type Parameters:

E -

Parameters:

list -

Returns:

a stack consisting of the elements of list in the order of list.iterator()

from

private static <E> ConsPStack<E> from(Iterator<? extends E> i)

size

public int size()

/ REQUIRED METHODS FROM AbstractSequentialList ////

Specified by:

size in interface Collection<E>

Specified by:

size in interface List<E>

Specified by:

size in class AbstractCollection<E>

listIterator

public ListIterator<E> listIterator(int index)

Specified by:

listIterator in interface List<E>

Specified by:

listIterator in class AbstractSequentialList<E>

subList

public ConsPStack<E> subList(int start,
 int end)

/ OVERRIDDEN METHODS FROM AbstractSequentialList ////

Specified by:

subList in interface List<E>

Specified by:

subList in interface PSequence<E>

Specified by:

subList in interface PStack<E>

Overrides:

subList in class AbstractList<E>

plus

public ConsPStack<E> plus(E e)

/ IMPLEMENTED METHODS OF PStack ////

Specified by:

plus in interface PCollection<E>

Specified by:

plus in interface PSequence<E>

Specified by:

plus in interface PStack<E>

Parameters:

e -

Returns:

a collection which contains e and all of the elements of this

plusAll

public ConsPStack<E> plusAll(Collection<? extends E> list)

Description copied from interface: PStack

Returns a stack consisting of the elements of this with list prepended in reverse.

Specified by:

plusAll in interface PCollection<E>

Specified by:

plusAll in interface PSequence<E>

Specified by:

plusAll in interface PStack<E>

Parameters:

list -

Returns:

a collection which contains all of the elements of list and this

plus

public ConsPStack<E> plus(int i,
 E e)

Specified by:

plus in interface PSequence<E>

Specified by:

plus in interface PStack<E>

Parameters:

i -

e -

Returns:

a sequence consisting of the elements of this with e inserted at index i.

plusAll

public ConsPStack<E> plusAll(int i,
 Collection<? extends E> list)

Specified by:

plusAll in interface PSequence<E>

Specified by:

plusAll in interface PStack<E>

Parameters:

i -

list -

Returns:

a sequence consisting of the elements of this with list inserted at index i.

minus

public ConsPStack<E> minus(Object e)

Description copied from interface: PSequence

Returns a sequence consisting of the elements of this without the first occurrence of e.

Specified by:

minus in interface PCollection<E>

Specified by:

minus in interface PSequence<E>

Specified by:

minus in interface PStack<E>

Parameters:

e -

Returns:

this with a single instance of e removed, if e is in this

minus

public ConsPStack<E> minus(int i)

Specified by:

minus in interface PSequence<E>

Specified by:

minus in interface PStack<E>

Parameters:

i -

Returns:

a sequence consisting of the elements of this with the element at index i removed.

minusAll

public ConsPStack<E> minusAll(Collection<?> list)

Specified by:

minusAll in interface PCollection<E>

Specified by:

minusAll in interface PSequence<E>

Specified by:

minusAll in interface PStack<E>

Parameters:

list -

Returns:

this with all elements of list completely removed

with

public ConsPStack<E> with(int i,
 E e)

Specified by:

with in interface PSequence<E>

Specified by:

with in interface PStack<E>

Parameters:

i -

e -

Returns:

a sequence consisting of the elements of this with e replacing the element at index i.

subList

public ConsPStack<E> subList(int start)

Specified by:

subList in interface PStack<E>

Parameters:

start -

Returns:

subList(start,this.size())