org.libj.util

Class TransCollection<S,T>

java.lang.Object

java.util.AbstractCollection<E>

org.libj.util.DelegateCollection<T>

org.libj.util.TransCollection<S,T>

Type Parameters:

S - Type of source Collection.

T - Type of target Collection.

All Implemented Interfaces:

Iterable<T>, Collection<T>

public class TransCollection<S,T>
extends DelegateCollection<T>

An implementation of the Collection interface that transforms the elements of the supplied source Collection based on sourceToTarget and targetToSource lambda functions.

See Also:

Collection

Field Summary

Fields

Modifier and Type	Field and Description
protected Function<S,T>	sourceToTarget
protected Function<T,S>	targetToSource

Fields inherited from class org.libj.util.DelegateCollection

target

Constructor Summary

Constructors

Constructor and Description
TransCollection(Collection<S> source, Function<S,T> sourceToTarget, Function<T,S> targetToSource) Creates a new TransCollection with the specified source Collection, and functions defining the translation of objects types S -> T and T -> S.

Method Summary

Modifier and Type	Method and Description
boolean	add(T e)
boolean	addAll(Collection<? extends T> c)
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
Iterator<T>	iterator()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
Object[]	toArray()
<E> E[]	toArray(E[] a)

Methods inherited from class org.libj.util.DelegateCollection

clear, equals, forEach, hashCode, isEmpty, parallelStream, removeIf, size, spliterator, stream, superForEach, superParallelStream, superRemoveIf, superSpliterator, superStream, toString

Methods inherited from class java.lang.Object

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

Field Detail

sourceToTarget

protected final Function<S,T> sourceToTarget

targetToSource

protected final Function<T,S> targetToSource

Constructor Detail

TransCollection

public TransCollection(Collection<S> source,
                       Function<S,T> sourceToTarget,
                       Function<T,S> targetToSource)

Creates a new TransCollection with the specified source Collection, and functions defining the translation of objects types S -> T and T -> S.

If sourceToTarget is null, all methods that require a translation of S -> T will throw a UnsupportedOperationException.

If targetToSource is null, all methods that require a translation of T -> S will throw a UnsupportedOperationException.

Parameters:

source - The source Collection of type <S>.

sourceToTarget - The Function defining the translation from S -> T.

targetToSource - The Function defining the translation from T -> S.

Throws:

NullPointerException - If source is null.

Method Detail

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T>

Overrides:

contains in class DelegateCollection<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Collection<T>

Overrides:

iterator in class DelegateCollection<T>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T>

Overrides:

toArray in class DelegateCollection<T>

toArray

public <E> E[] toArray(E[] a)

Specified by:

toArray in interface Collection<T>

Overrides:

toArray in class DelegateCollection<T>

add

public boolean add(T e)

Specified by:

add in interface Collection<T>

Overrides:

add in class DelegateCollection<T>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<T>

Overrides:

remove in class DelegateCollection<T>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T>

Overrides:

containsAll in class DelegateCollection<T>

addAll

public boolean addAll(Collection<? extends T> c)

Specified by:

addAll in interface Collection<T>

Overrides:

addAll in class DelegateCollection<T>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<T>

Overrides:

removeAll in class DelegateCollection<T>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<T>

Overrides:

retainAll in class DelegateCollection<T>