org.opencastproject.util.data

Class Monadics.ListMonadic<A>

java.lang.Object

org.opencastproject.util.data.Monadics.ListMonadic<A>

All Implemented Interfaces:

Iterable<A>

Enclosing class:

Monadics

public abstract static class Monadics.ListMonadic<A>
extends Object
implements Iterable<A>

The list monad.

Method Summary

Modifier and Type	Method and Description
abstract <B> Monadics.ListMonadic<B>	bind(Function<? super A,? extends Iterable<B>> f) Monadic bind m a -> (a -> m b) -> m b.
abstract <M extends Iterable<A>> Monadics.ListMonadic<A>	concat(M m) Append a to the list.
abstract <X extends A> Monadics.ListMonadic<A>	cons(X a) Construct a new list by prepending a.
abstract Monadics.ListMonadic<A>	drop(int n) Drop the first n elements of the list.
abstract Monadics.ListMonadic<A>	each(Function<? super A,Void> e) Apply side effect e to each element.
abstract Monadics.ListMonadic<A>	eachIndex(Function2<? super A,? super Integer,Void> e) Apply side effect e to each element.
abstract boolean	exists(Function<? super A,Boolean> p) Check if at least one element satisfies predicate p.
abstract Monadics.ListMonadic<A>	filter(Function<? super A,Boolean> p) Retain all elements satisfying predicate p.
abstract Option<A>	find(Function<? super A,Boolean> p) Return the first element satisfying predicate p.
<B> Monadics.ListMonadic<B>	flatMap(Function<? super A,? extends Iterable<B>> f) Alias for bind(Function).
abstract <B> Monadics.ListMonadic<B>	fmap(Function<? super A,? extends B> f) Apply f to each elements building a new list.
abstract <B> B	foldl(B zero, Function2<? super B,? super A,? extends B> f) Fold the list from left to right applying binary operator f starting with zero.
abstract A	head() Return the head of the list.
abstract Option<A>	headOpt() Return the head of the list.
abstract <B> Monadics.ListMonadic<B>	inspect(Function<? super List<A>,? extends List<B>> f) Process the wrapped list en bloc.
abstract A	last() Return the last element of the list.
abstract Option<A>	lastOpt() Return the last element of the list.
<B> Monadics.ListMonadic<B>	map(Function<? super A,? extends B> f) Alias for fmap.
<B> B	match(List<Monadics.Matcher<A,B>> ms) Pattern matching on the wrapped list.
<B> B	match(Monadics.Matcher<A,B>... ms) Pattern matching on the wrapped list.
abstract String	mkString(String sep)
abstract Option<A>	option() Turn the list into an option only if it contains exactly one element.
abstract A	reducel(Function2<? super A,? super A,? extends A> f) Reduce the list from left to right applying binary operator f.
abstract Monadics.ListMonadic<A>	reverse()
abstract Monadics.ListMonadic<A>	sort(Comparator<A> c)
abstract Monadics.ListMonadic<A>	tail() Return the tail of the list.
abstract Monadics.ListMonadic<A>	take(int n) Limit the list to the first n elements.
abstract List<A>	value() Return the wrapped, unmodifiable list.
abstract <B> Monadics.ListMonadic<Tuple<A,B>>	zip(B[] bs)
abstract <B> Monadics.ListMonadic<Tuple<A,B>>	zip(Iterator<B> bs)
abstract <B,M extends Iterable<B>> Monadics.ListMonadic<Tuple<A,B>>	zip(M bs)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

map

public final <B> Monadics.ListMonadic<B> map(Function<? super A,? extends B> f)

Alias for fmap.

fmap

public abstract <B> Monadics.ListMonadic<B> fmap(Function<? super A,? extends B> f)

Apply f to each elements building a new list. This is the list functor.

See Also:

map(Function)

flatMap

public final <B> Monadics.ListMonadic<B> flatMap(Function<? super A,? extends Iterable<B>> f)

Alias for bind(Function).

bind

public abstract <B> Monadics.ListMonadic<B> bind(Function<? super A,? extends Iterable<B>> f)

Monadic bind m a -> (a -> m b) -> m b. Apply f to each elements concatenating the results into a new list.

foldl

public abstract <B> B foldl(B zero,
                            Function2<? super B,? super A,? extends B> f)

Fold the list from left to right applying binary operator f starting with zero.

reducel

public abstract A reducel(Function2<? super A,? super A,? extends A> f)

Reduce the list from left to right applying binary operator f. The list must not be empty.

concat

public abstract <M extends Iterable<A>> Monadics.ListMonadic<A> concat(M m)

Append a to the list.

cons

public abstract <X extends A> Monadics.ListMonadic<A> cons(X a)

Construct a new list by prepending a.

filter

public abstract Monadics.ListMonadic<A> filter(Function<? super A,Boolean> p)

Retain all elements satisfying predicate p.

find

public abstract Option<A> find(Function<? super A,Boolean> p)

Return the first element satisfying predicate p.

exists

public abstract boolean exists(Function<? super A,Boolean> p)

Check if at least one element satisfies predicate p.

each

public abstract Monadics.ListMonadic<A> each(Function<? super A,Void> e)

Apply side effect e to each element.

eachIndex

public abstract Monadics.ListMonadic<A> eachIndex(Function2<? super A,? super Integer,Void> e)

Apply side effect e to each element. Indexed version.

zip

public abstract <B,M extends Iterable<B>> Monadics.ListMonadic<Tuple<A,B>> zip(M bs)

zip

public abstract <B> Monadics.ListMonadic<Tuple<A,B>> zip(B[] bs)

zip

public abstract <B> Monadics.ListMonadic<Tuple<A,B>> zip(Iterator<B> bs)

sort

public abstract Monadics.ListMonadic<A> sort(Comparator<A> c)

reverse

public abstract Monadics.ListMonadic<A> reverse()

headOpt

public abstract Option<A> headOpt()

Return the head of the list.

head

public abstract A head()

Return the head of the list.

last

public abstract A last()

Return the last element of the list.

lastOpt

public abstract Option<A> lastOpt()

Return the last element of the list.

option

public abstract Option<A> option()

Turn the list into an option only if it contains exactly one element.

tail

public abstract Monadics.ListMonadic<A> tail()

Return the tail of the list.

take

public abstract Monadics.ListMonadic<A> take(int n)

Limit the list to the first n elements.

drop

public abstract Monadics.ListMonadic<A> drop(int n)

Drop the first n elements of the list.

inspect

public abstract <B> Monadics.ListMonadic<B> inspect(Function<? super List<A>,? extends List<B>> f)

Process the wrapped list en bloc.

match

public final <B> B match(Monadics.Matcher<A,B>... ms)

Pattern matching on the wrapped list.

match

public final <B> B match(List<Monadics.Matcher<A,B>> ms)

Pattern matching on the wrapped list.

mkString

public abstract String mkString(String sep)

value

public abstract List<A> value()

Return the wrapped, unmodifiable list.