Package org.organicdesign.fp.collections

Interface MutableList<E>

All Superinterfaces:

BaseList<E>, java.util.Collection<E>, java.lang.Iterable<E>, java.util.List<E>, Sized, Transformable<E>, UnmodCollection<E>, UnmodIterable<E>, UnmodList<E>, UnmodSortedCollection<E>, UnmodSortedIterable<E>

All Known Implementing Classes:

PersistentVector.MutableVector, RrbTree.MutableRrbt

public interface MutableList<E>
extends BaseList<E>

A mutate-in-place interface using the same copy-on-write methods as BaseList and ImList so that you can treat mutable and immutable lists the same. You could think of this as a builder for an ImList, or just a stand-alone MutableList that behaves similarly (extends Transformable). Being mutable, this is inherently NOT thread-safe.

Nested Class Summary

Nested classes/interfaces inherited from interface org.organicdesign.fp.collections.UnmodList

UnmodList.AbstractUnmodList<E>

Method Summary

Modifier and Type	Method	Description
MutableList<E>	append(E val)	Adds one item to the end of the ImList.
default MutableList<E>	concat(java.lang.Iterable<? extends E> es)	Efficiently adds items to the end of this ImList.
ImList<E>	immutable()	Returns a immutable version of this mutable list.
MutableList<E>	replace(int idx, E e)	Replace the item at the given index.
default MutableList<E>	reverse()	Returns a reversed copy of this list.

Methods inherited from interface org.organicdesign.fp.collections.BaseList

get, head

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

equals, get, hashCode, size, spliterator

Methods inherited from interface org.organicdesign.fp.collections.Sized

size

Methods inherited from interface org.organicdesign.fp.xform.Transformable

toImList, toImMap, toImRrbt, toImSet, toImSortedMap, toImSortedSet, toMutableList, toMutableMap, toMutableRrbt, toMutableSet, toMutableSortedMap, toMutableSortedSet

Methods inherited from interface org.organicdesign.fp.collections.UnmodIterable

drop, dropWhile, filter, flatMap, fold, foldUntil, map, precat, take, takeWhile

Methods inherited from interface org.organicdesign.fp.collections.UnmodList

add, add, addAll, addAll, clear, contains, containsAll, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, replaceAll, retainAll, set, sort, subList, toArray, toArray

Method Detail

append

MutableList<E> append(E val)

Adds one item to the end of the ImList.

Specified by:

append in interface BaseList<E>

Parameters:

val - the value to insert

Returns:

a new ImList with the additional item at the end.

immutable

ImList<E> immutable()

Returns a immutable version of this mutable list.

concat

default MutableList<E> concat(java.lang.Iterable<? extends E> es)

Efficiently adds items to the end of this ImList.

Specified by:

concat in interface BaseList<E>

Specified by:

concat in interface Transformable<E>

Specified by:

concat in interface UnmodIterable<E>

Parameters:

es - the values to insert

Returns:

a new ImList with the additional items at the end.

replace

MutableList<E> replace(int idx,
                       E e)

Replace the item at the given index. Note: i.replace(i.size(), o) used to be equivalent to i.concat(o), but it probably won't be for the RRB tree implementation, so this will change too.

Specified by:

replace in interface BaseList<E>

Parameters:

idx - the index where the value should be stored.

e - the value to store

Returns:

a new ImList with the replaced item

reverse

default MutableList<E> reverse()

Returns a reversed copy of this list.

Specified by:

reverse in interface BaseList<E>