com.ideaheap.barelyfunctional.data

Class BfLists

java.lang.Object

com.ideaheap.barelyfunctional.data.BfLists

public class BfLists
extends Object

An immutable list library. Convenience functions for dealing with lists.

Constructor Summary

Constructors

Constructor and Description
BfLists()

Method Summary

Modifier and Type	Method and Description
static <T> List<T>	assoc(List<T> list, int idx, T val) Return an updated list with the specified value at the specified index.
static <T> List<T>	insert(List<T> list, int idx, T val) Return an updated list with the specified value at the specified index inserted.
static <T> List<T>	list(T... elements) Generates list primitive.
static <T> List<T>	merge(Collection<T>... lists) combine all collections given into one immutable list.
static <T> List<T>	push(List<T> list, T... end) Add elements to the end of a list.
static <T> List<T>	remove(List<T> list, int idx) Return an updated list with the specified value at the specified index removed.
static <T> List<T>	unshift(List<T> list, T... head) Add elements to the beginning of a list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BfLists

public BfLists()

Method Detail

list

public static <T> List<T> list(T... elements)

Generates list primitive.

Parameters:

elements - elements to add.

Returns:

An immutable list of the elements presented.

merge

public static <T> List<T> merge(Collection<T>... lists)

combine all collections given into one immutable list. Collections are added in order.

Parameters:

lists -

Returns:

assoc

public static <T> List<T> assoc(List<T> list,
                                int idx,
                                T val)

Return an updated list with the specified value at the specified index.

Parameters:

list - The list to create a new version of

idx - the index for the value

val - the new value

Returns:

An updated list with the new value.

remove

public static <T> List<T> remove(List<T> list,
                                 int idx)

Return an updated list with the specified value at the specified index removed.

Parameters:

list - The list to create a new version of

idx - the index for the value

Returns:

An updated list with the value at the specified position removed.

insert

public static <T> List<T> insert(List<T> list,
                                 int idx,
                                 T val)

Return an updated list with the specified value at the specified index inserted.

Parameters:

list - The list to create a new version of

idx - the index for the value

Returns:

An updated list with the value at the specified position inserted.

push

public static <T> List<T> push(List<T> list,
                               T... end)

Add elements to the end of a list.

Parameters:

list - The list to add to.

end - The elements to add.

Returns:

A new list with the elements specified added to the end.

unshift

public static <T> List<T> unshift(List<T> list,
                                  T... head)

Add elements to the beginning of a list.

Parameters:

list - The list to add.

head - The set of elements to put at the beginning of the list.

Returns: