io.purush.java.immutable.collections

Interface List<E>

public interface List<E>

A simplistic abstraction of immutable Lists.
Ability to add, remove, update elements to/from the List.
Additional ability to merge, split, piece-out lists from a List.

Since:

1.0

Author:

Purush Swaminathan

Method Summary

Modifier and Type	Method and Description
List<E>	add(E e) Add an element to this List and return a fresh list containing it.
E	get(int index) Return the element at index given.
List<E>	merge(List<E> e1, List<E> e2) Merge two lists into one.
List<E>	piece(int from, int to) Piece out the list and return the piece between two indices.
List<E>	remove(E e) Creates a fresh List without the first occurrence of e.
Tuple2<List<E>,List<E>>	splitAt(int x) Splits the list at an index x into two pieces.
List<E>	update(int index, E e) Update element at an index to this List and return a fresh list containing it.

Method Detail

add

List<E> add(E e)

Add an element to this List and return a fresh list containing it.

Parameters:

e -

Returns:

fresh List

update

List<E> update(int index,
               E e)

Update element at an index to this List and return a fresh list containing it. Implementations should maintain the List remain immutable.

Parameters:

index -

e -

Returns:

fresh List

remove

List<E> remove(E e)

Creates a fresh List without the first occurrence of e.

Returns:

fresh List without e

get

E get(int index)

Return the element at index given.

Parameters:

index -

Returns:

E

piece

List<E> piece(int from,
              int to)

Piece out the list and return the piece between two indices.

Parameters:

from - - start index inclusive

to - - end index exclusive

Returns:

a sub-list of elements in the List between `from`(inclusive) and `to`(exclusive).

splitAt

Tuple2<List<E>,List<E>> splitAt(int x)

Splits the list at an index x into two pieces.

Parameters:

x -

Returns:

Tuple2,List> a tuple of two lists

merge

List<E> merge(List<E> e1,
              List<E> e2)

Merge two lists into one.