org.organicdesign.fp.collections

Interface ImList<E>

All Superinterfaces:

Collection<E>, Iterable<E>, List<E>, Sized, Transformable<E>, UnmodCollection<E>, UnmodIterable<E>, UnmodList<E>, UnmodSortedCollection<E>, UnmodSortedIterable<E>

All Known Subinterfaces:

MutableList<E>

All Known Implementing Classes:

PersistentVector, PersistentVector.MutableVector

public interface ImList<E>
extends UnmodList<E>

Holds Immutable "modification" methods that return a new ImList reflecting the modification while sharing as much data structure with the previous ImList as possible (for performance).

Nested Class Summary

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

UnmodList.AbstractUnmodList<E>

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

UnmodIterable.AbstractUnmodIterable<T>

Method Summary

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

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

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

Methods inherited from interface java.util.List

equals, get, hashCode, size, spliterator

Methods inherited from interface java.util.Collection

parallelStream, stream

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

size

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

castFromList, castFromSortedMap, castFromSortedSet, equal, equals

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

drop, filter, flatMap, foldLeft, foldLeft, hash, hashCode, head, map, precat, take, takeWhile, toString

Methods inherited from interface java.lang.Iterable

forEach

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

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

Method Detail

append

ImList<E> append(E e)

Adds one item to the end of the ImList.

Parameters:

e - the value to insert

Returns:

a new ImList with the additional item at the end.

concat

default ImList<E> concat(Iterable<? extends E> es)

Efficiently adds items to the end of this ImList.

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.

mutable

MutableList<E> mutable()

Returns a mutable list (builder)

get

default E get(int i,
              E notFound)

Returns the item at this index.

Parameters:

i - the zero-based index to get from the vector.

notFound - the value to return if the index is out of bounds.

Returns:

the value at that index, or the notFound value.

immutable

ImList<E> immutable()

Returns a immutable version of this mutable list.

replace

ImList<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.

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 ImList<E> reverse()

Returns a reversed copy of this list.