Class Underscore.Chain<T>

java.lang.Object

com.github.underscore.Underscore.Chain<T>

Direct Known Subclasses:

U.Chain

Enclosing class:

Underscore<T>

public static class Underscore.Chain<T>
extends Object

Author:

Valentyn Kolesnikov

Field Summary

Fields

Modifier and Type	Field	Description
private final T	item
private final List<T>	list
private final Map<String,Object>	map

Constructor Summary

Constructors

Constructor	Description
Chain(List<T> list)
Chain(Map<String,Object> map)
Chain(T item)

Method Summary

Modifier and Type	Method	Description
<F> Underscore.Chain<Map<F,T>>	associateBy(Function<T,F> func)
Underscore.Chain<List<T>>	chunk(int size)
Underscore.Chain<List<T>>	chunk(int size, int step)
Underscore.Chain<List<T>>	chunkFill(int size, int step, T fillValue)
Underscore.Chain<List<T>>	chunkFill(int size, T fillValue)
Underscore.Chain<T>	compact()
Underscore.Chain<T>	compact(T falsyValue)
Underscore.Chain<T>	concat(List<T>... lists)
Underscore.Chain<Boolean>	contains(T elem)
Underscore.Chain<Boolean>	containsWith(T elem)
Underscore.Chain<Integer>	count(Predicate<T> pred)
Underscore.Chain<Map<T,Integer>>	countBy()
<F> Underscore.Chain<Map<F,Integer>>	countBy(Function<T,F> func)
Underscore.Chain<T>	cycle(int times)
Underscore.Chain<T>	difference(List<T>... lists)
Underscore.Chain<T>	distinct()
<F> Underscore.Chain<F>	distinctBy(Function<T,F> func)
Underscore.Chain<Boolean>	every(Predicate<T> pred)
Underscore.Chain<T>	filter(Predicate<T> pred)
Underscore.Chain<T>	filterFalse(Predicate<T> pred)
Underscore.Chain<T>	filterIndexed(Underscore.PredicateIndexed<T> pred)
Underscore.Chain<Optional<T>>	find(Predicate<T> pred)
Underscore.Chain<Optional<T>>	findLast(Predicate<T> pred)
<E> Underscore.Chain<Optional<T>>	findWhere(List<Map.Entry<String,E>> properties)
Underscore.Chain<T>	first()
Underscore.Chain<T>	first(int n)
Underscore.Chain<T>	first(Predicate<T> pred)
Underscore.Chain<T>	first(Predicate<T> pred, int n)
Underscore.Chain<T>	firstOrNull()
Underscore.Chain<T>	firstOrNull(Predicate<T> pred)
Underscore.Chain	flatten()
Underscore.Chain<T>	forEach(Consumer<T> func)
Underscore.Chain<T>	forEachRight(Consumer<T> func)
<F> Underscore.Chain<Map<F,List<T>>>	groupBy(Function<T,F> func)
<F> Underscore.Chain<Map<F, Optional<T>>>	groupBy(Function<T,F> func, BinaryOperator<T> binaryOperator)
Underscore.Chain<Map<Object,List<T>>>	indexBy(String property)
Underscore.Chain<T>	initial()
Underscore.Chain<T>	initial(int n)
Underscore.Chain<T>	interpose(T element)
Underscore.Chain<T>	interposeByList(Iterable<T> interIter)
Underscore.Chain<T>	intersection(List<T>... lists)
Underscore.Chain<T>	invoke(String methodName)
Underscore.Chain<T>	invoke(String methodName, List<Object> args)
boolean	isEmpty()
boolean	isNotEmpty()
T	item()
Underscore.Chain<String>	join()
Underscore.Chain<String>	join(String separator)
Underscore.Chain<T>	last()
Underscore.Chain<T>	last(int n)
Underscore.Chain<T>	lastOrNull()
Underscore.Chain<T>	lastOrNull(Predicate<T> pred)
Underscore.Chain<T>	limit(int size)
Map<String,Object>	map()
<F> Underscore.Chain<F>	map(Function<? super T, F> func)
<F> Underscore.Chain<F>	mapIndexed(BiFunction<Integer, ? super T, F> func)
<F> Underscore.Chain<F>	mapMulti(BiConsumer<? super T, ? super Consumer<F>> mapper)
Underscore.Chain<Comparable>	max()
<F extends Comparable<? super F>> Underscore.Chain<T>	max(Function<T,F> func)
Underscore.Chain<Comparable>	min()
<F extends Comparable<? super F>> Underscore.Chain<T>	min(Function<T,F> func)
Underscore.Chain<Object>	pluck(String propertyName)
Underscore.Chain<Map.Entry<T,List<T>>>	pop()
Underscore.Chain<T>	push(T... values)
Underscore.Chain<Integer>	range(int stop)
Underscore.Chain<Integer>	range(int start, int stop)
Underscore.Chain<Integer>	range(int start, int stop, int step)
<F> Underscore.Chain<F>	reduce(BiFunction<F,T,F> func, F zeroElem)
Underscore.Chain<Optional<T>>	reduce(BinaryOperator<T> func)
<F> Underscore.Chain<F>	reduceRight(BiFunction<F,T,F> func, F zeroElem)
Underscore.Chain<Optional<T>>	reduceRight(BinaryOperator<T> func)
Underscore.Chain<T>	reject(Predicate<T> pred)
Underscore.Chain<T>	rejectIndexed(Underscore.PredicateIndexed<T> pred)
Underscore.Chain<T>	replace(Predicate<T> pred, T value)
Underscore.Chain<T>	replaceIndexed(Underscore.PredicateIndexed<T> pred, T value)
Underscore.Chain<T>	rest()
Underscore.Chain<T>	rest(int n)
Underscore.Chain<T>	reverse()
Underscore.Chain<T>	sample()
Underscore.Chain<T>	sample(int howMany)
Underscore.Chain<Map.Entry<T,List<T>>>	shift()
Underscore.Chain<T>	shuffle()
int	size()
Underscore.Chain<T>	skip(int numberToSkip)
Underscore.Chain<T>	slice(int start)
Underscore.Chain<T>	slice(int start, int end)
Underscore.Chain<Boolean>	some(Predicate<T> pred)
Underscore.Chain<Comparable>	sort()
<F extends Comparable<? super F>> Underscore.Chain<T>	sortBy(Function<T,F> func)
<K> Underscore.Chain<Map<K, Comparable>>	sortBy(K key)
<F extends Comparable<? super F>> Underscore.Chain<F>	sortWith(Comparator<F> comparator)
Underscore.Chain<List<T>>	splitAt(int position)
Underscore.Chain<T>	takeSkipping(int stepSize)
Underscore.Chain<T>	tap(Consumer<T> func)
List<T>	toList()
<K,V> Underscore.Chain<Map<K,V>>	toMap()
String	toString()
Underscore.Chain<T>	union(List<T>... lists)
Underscore.Chain<T>	uniq()
<F> Underscore.Chain<T>	uniq(Function<T,F> func)
Underscore.Chain<T>	unshift(T... values)
List<T>	value()
<E> Underscore.Chain<T>	where(List<Map.Entry<String,E>> properties)

Methods inherited from class Object

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

Field Details

item

private final T item

list

private final List<T> list

map

private final Map<String,Object> map

Constructor Details

Chain

public Chain(T item)

Chain

public Chain(List<T> list)

Chain

public Chain(Map<String,Object> map)

Method Details

first

public Underscore.Chain<T> first()

first

public Underscore.Chain<T> first(int n)

first

public Underscore.Chain<T> first(Predicate<T> pred)

first

public Underscore.Chain<T> first(Predicate<T> pred,
 int n)

firstOrNull

public Underscore.Chain<T> firstOrNull()

firstOrNull

public Underscore.Chain<T> firstOrNull(Predicate<T> pred)

initial

public Underscore.Chain<T> initial()

initial

public Underscore.Chain<T> initial(int n)

last

public Underscore.Chain<T> last()

last

public Underscore.Chain<T> last(int n)

lastOrNull

public Underscore.Chain<T> lastOrNull()

lastOrNull

public Underscore.Chain<T> lastOrNull(Predicate<T> pred)

rest

public Underscore.Chain<T> rest()

rest

public Underscore.Chain<T> rest(int n)

compact

public Underscore.Chain<T> compact()

compact

public Underscore.Chain<T> compact(T falsyValue)

flatten

public Underscore.Chain flatten()

map

public <F> Underscore.Chain<F> map(Function<? super T, F> func)

mapMulti

public <F> Underscore.Chain<F> mapMulti(BiConsumer<? super T, ? super Consumer<F>> mapper)

mapIndexed

public <F> Underscore.Chain<F> mapIndexed(BiFunction<Integer, ? super T, F> func)

replace

public Underscore.Chain<T> replace(Predicate<T> pred,
 T value)

replaceIndexed

public Underscore.Chain<T> replaceIndexed(Underscore.PredicateIndexed<T> pred,
 T value)

filter

public Underscore.Chain<T> filter(Predicate<T> pred)

filterIndexed

public Underscore.Chain<T> filterIndexed(Underscore.PredicateIndexed<T> pred)

reject

public Underscore.Chain<T> reject(Predicate<T> pred)

rejectIndexed

public Underscore.Chain<T> rejectIndexed(Underscore.PredicateIndexed<T> pred)

filterFalse

public Underscore.Chain<T> filterFalse(Predicate<T> pred)

reduce

public <F> Underscore.Chain<F> reduce(BiFunction<F,T,F> func,
 F zeroElem)

reduce

public Underscore.Chain<Optional<T>> reduce(BinaryOperator<T> func)

reduceRight

public <F> Underscore.Chain<F> reduceRight(BiFunction<F,T,F> func,
 F zeroElem)

reduceRight

public Underscore.Chain<Optional<T>> reduceRight(BinaryOperator<T> func)

find

public Underscore.Chain<Optional<T>> find(Predicate<T> pred)

findLast

public Underscore.Chain<Optional<T>> findLast(Predicate<T> pred)

max

public Underscore.Chain<Comparable> max()

max

public <F extends Comparable<? super F>>
Underscore.Chain<T> max(Function<T,F> func)

min

public Underscore.Chain<Comparable> min()

min

public <F extends Comparable<? super F>>
Underscore.Chain<T> min(Function<T,F> func)

sort

public Underscore.Chain<Comparable> sort()

sortWith

public <F extends Comparable<? super F>>
Underscore.Chain<F> sortWith(Comparator<F> comparator)

sortBy

public <F extends Comparable<? super F>>
Underscore.Chain<T> sortBy(Function<T,F> func)

sortBy

public <K> Underscore.Chain<Map<K, Comparable>> sortBy(K key)

groupBy

public <F> Underscore.Chain<Map<F,List<T>>> groupBy(Function<T,F> func)

associateBy

public <F> Underscore.Chain<Map<F,T>> associateBy(Function<T,F> func)

groupBy

public <F> Underscore.Chain<Map<F, Optional<T>>> groupBy(Function<T,F> func,
 BinaryOperator<T> binaryOperator)

indexBy

public Underscore.Chain<Map<Object,List<T>>> indexBy(String property)

countBy

public <F> Underscore.Chain<Map<F,Integer>> countBy(Function<T,F> func)

countBy

public Underscore.Chain<Map<T,Integer>> countBy()

shuffle

public Underscore.Chain<T> shuffle()

sample

public Underscore.Chain<T> sample()

sample

public Underscore.Chain<T> sample(int howMany)

tap

public Underscore.Chain<T> tap(Consumer<T> func)

forEach

public Underscore.Chain<T> forEach(Consumer<T> func)

forEachRight

public Underscore.Chain<T> forEachRight(Consumer<T> func)

every

public Underscore.Chain<Boolean> every(Predicate<T> pred)

some

public Underscore.Chain<Boolean> some(Predicate<T> pred)

count

public Underscore.Chain<Integer> count(Predicate<T> pred)

contains

public Underscore.Chain<Boolean> contains(T elem)

containsWith

public Underscore.Chain<Boolean> containsWith(T elem)

invoke

public Underscore.Chain<T> invoke(String methodName,
 List<Object> args)

invoke

public Underscore.Chain<T> invoke(String methodName)

pluck

public Underscore.Chain<Object> pluck(String propertyName)

where

public <E> Underscore.Chain<T> where(List<Map.Entry<String,E>> properties)

findWhere

public <E> Underscore.Chain<Optional<T>> findWhere(List<Map.Entry<String,E>> properties)

uniq

public Underscore.Chain<T> uniq()

uniq

public <F> Underscore.Chain<T> uniq(Function<T,F> func)

distinct

public Underscore.Chain<T> distinct()

distinctBy

public <F> Underscore.Chain<F> distinctBy(Function<T,F> func)

union

public Underscore.Chain<T> union(List<T>... lists)

intersection

public Underscore.Chain<T> intersection(List<T>... lists)

difference

public Underscore.Chain<T> difference(List<T>... lists)

range

public Underscore.Chain<Integer> range(int stop)

range

public Underscore.Chain<Integer> range(int start,
 int stop)

range

public Underscore.Chain<Integer> range(int start,
 int stop,
 int step)

chunk

public Underscore.Chain<List<T>> chunk(int size)

chunk

public Underscore.Chain<List<T>> chunk(int size,
 int step)

chunkFill

public Underscore.Chain<List<T>> chunkFill(int size,
 T fillValue)

chunkFill

public Underscore.Chain<List<T>> chunkFill(int size,
 int step,
 T fillValue)

cycle

public Underscore.Chain<T> cycle(int times)

interpose

public Underscore.Chain<T> interpose(T element)

interposeByList

public Underscore.Chain<T> interposeByList(Iterable<T> interIter)

concat

public Underscore.Chain<T> concat(List<T>... lists)

slice

public Underscore.Chain<T> slice(int start)

slice

public Underscore.Chain<T> slice(int start,
 int end)

splitAt

public Underscore.Chain<List<T>> splitAt(int position)

takeSkipping

public Underscore.Chain<T> takeSkipping(int stepSize)

reverse

public Underscore.Chain<T> reverse()

join

public Underscore.Chain<String> join()

join

public Underscore.Chain<String> join(String separator)

push

public Underscore.Chain<T> push(T... values)

pop

public Underscore.Chain<Map.Entry<T,List<T>>> pop()

shift

public Underscore.Chain<Map.Entry<T,List<T>>> shift()

unshift

public Underscore.Chain<T> unshift(T... values)

skip

public Underscore.Chain<T> skip(int numberToSkip)

limit

public Underscore.Chain<T> limit(int size)

toMap

public <K,V> Underscore.Chain<Map<K,V>> toMap()

isEmpty

public boolean isEmpty()

isNotEmpty

public boolean isNotEmpty()

size

public int size()

item

public T item()

value

public List<T> value()

map

public Map<String,Object> map()

toList

public List<T> toList()

toString

public String toString()

Overrides:

toString in class Object