Class TupleList<L,R>

java.lang.Object

com.google.common.collect.ForwardingObject

com.google.common.collect.ForwardingCollection<Tuple<L,R>>

com.google.common.collect.ForwardingList<Tuple<L,R>>

nl.colorize.util.TupleList<L,R>

Type Parameters:

L - Type of the first (left) element.

R - Type of the second (right) element.

All Implemented Interfaces:

Iterable<Tuple<L,R>>, Collection<Tuple<L,R>>, List<Tuple<L,R>>, SequencedCollection<Tuple<L,R>>

public class TupleList<L,R>
extends com.google.common.collect.ForwardingList<Tuple<L,R>>

Convenience class that can be used as a shorthand for creating a list of Tuples.

Constructor Summary

Constructors

Constructor	Description
TupleList()

Method Summary

Modifier and Type	Method	Description
void	add(L left, R right)
TupleList<L,R>	append(L left, R right)	Adds a tuple to the list, then returns this TupleList instance.
static <L,R> TupleList<L,R>	combine(List<L> leftEntries, List<R> rightEntries)	Creates a TupleList by combining two lists.
TupleList<L,R>	concat(TupleList<L,R> other)	Returns a new TupleList that will contain all tuples from this list, followed by all tuples from other.
static <L,R> TupleList<L,R>	copyOf(Iterable<Tuple<L,R>> entries)	Factory method that creates a mutable TupleList from a number of existing tuples.
static <L,R> TupleList<L,R>	create()	Factory method that creates a TupleList that is mutable and initially empty.
protected List<Tuple<L,R>>	delegate()
static <L,R> TupleList<L,R>	empty()	Creates a new TupleList that is initially empty, and will throw an UnsupportedOperationException when trying to modify it.
void	forEach(BiConsumer<L,R> callback)
static <L,R> TupleList<L,R>	fromMap(Map<L,R> values)	Factory method that creates a mutable TupleList from a map.
static <L,R> TupleList<L,R>	fromStream(Stream<Tuple<L,R>> tuples)	Factory method that creates a mutable TupleList from an existing stream of tuples.
List<L>	getLeft()	Returns a list consisting of the left element of every tuple.
List<R>	getRight()	Returns a list consisting of the right element of every tuple.
TupleList<L,R>	immutable()	Creates a new TupleList that contains the same elements as this one, but does not allow modification.
TupleList<R,L>	inverse()	Returns a new TupleList where every tuple is the inverse of the tuples in this list.
<L2,R2> TupleList<L2,R2>	map(Function<L,L2> leftMapper, Function<R,R2> rightMapper)
static <L,R> TupleList<L,R>	of(L left, R right)
static <L,R> TupleList<L,R>	of(L leftA, R rightA, L leftB, R rightB)
static <L,R> TupleList<L,R>	of(L leftA, R rightA, L leftB, R rightB, L leftC, R rightC)

Methods inherited from class com.google.common.collect.ForwardingList

add, addAll, equals, get, hashCode, indexOf, lastIndexOf, listIterator, listIterator, remove, set, standardAdd, standardAddAll, standardEquals, standardHashCode, standardIndexOf, standardIterator, standardLastIndexOf, standardListIterator, standardListIterator, standardSubList, subList

Methods inherited from class com.google.common.collect.ForwardingCollection

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, standardAddAll, standardClear, standardContains, standardContainsAll, standardIsEmpty, standardRemove, standardRemoveAll, standardRetainAll, standardToArray, standardToArray, standardToString, toArray, toArray

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface Iterable

forEach

Methods inherited from interface List

add, addAll, addFirst, addLast, clear, contains, containsAll, getFirst, getLast, isEmpty, iterator, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, size, sort, spliterator, toArray, toArray

Constructor Details

TupleList

public TupleList()

Method Details

delegate

protected List<Tuple<L,R>> delegate()

Specified by:

delegate in class com.google.common.collect.ForwardingList<Tuple<L,R>>

add

public void add(L left,
 R right)

append

public TupleList<L,R> append(L left,
 R right)

Adds a tuple to the list, then returns this TupleList instance. This method is similar to add(Object, Object) but can be used for method chaining.

getLeft

public List<L> getLeft()

Returns a list consisting of the left element of every tuple.

getRight

public List<R> getRight()

Returns a list consisting of the right element of every tuple.

forEach

public void forEach(BiConsumer<L,R> callback)

inverse

public TupleList<R,L> inverse()

Returns a new TupleList where every tuple is the inverse of the tuples in this list. Note the order of the tuples within the list will not change, this will only affect the tuples themselves.

concat

public TupleList<L,R> concat(TupleList<L,R> other)

Returns a new TupleList that will contain all tuples from this list, followed by all tuples from other. This method is different from ForwardingCollection.addAll(Collection) in that it does not modify the current list, and instead always creates and returns a new TupleList instance.

map

public <L2,R2> TupleList<L2,R2> map(Function<L,L2> leftMapper,
 Function<R,R2> rightMapper)

immutable

public TupleList<L,R> immutable()

Creates a new TupleList that contains the same elements as this one, but does not allow modification. Attempting to modify the contents will result in an UnsupportedOperationException.

create

public static <L,R> TupleList<L,R> create()

Factory method that creates a TupleList that is mutable and initially empty.

of

public static <L,R> TupleList<L,R> of(L left,
 R right)

of

public static <L,R> TupleList<L,R> of(L leftA,
 R rightA,
 L leftB,
 R rightB)

of

public static <L,R> TupleList<L,R> of(L leftA,
 R rightA,
 L leftB,
 R rightB,
 L leftC,
 R rightC)

copyOf

public static <L,R> TupleList<L,R> copyOf(Iterable<Tuple<L,R>> entries)

Factory method that creates a mutable TupleList from a number of existing tuples.

fromStream

public static <L,R> TupleList<L,R> fromStream(Stream<Tuple<L,R>> tuples)

Factory method that creates a mutable TupleList from an existing stream of tuples.

fromMap

public static <L,R> TupleList<L,R> fromMap(Map<L,R> values)

Factory method that creates a mutable TupleList from a map. The map keys will act as the left element in each tuple, with the corresponding values acting as the right element.

combine

public static <L,R> TupleList<L,R> combine(List<L> leftEntries,
 List<R> rightEntries)

Creates a TupleList by combining two lists. Each tuple in the result will consist of an element from each list.

Throws:

IllegalArgumentException - if the two lists do not have the same length.

empty

public static <L,R> TupleList<L,R> empty()

Creates a new TupleList that is initially empty, and will throw an UnsupportedOperationException when trying to modify it.