org.apache.commons.collections4.list

Class TransformedList<E>

java.lang.Object

org.apache.commons.collections4.collection.AbstractCollectionDecorator<E>

org.apache.commons.collections4.collection.TransformedCollection<E>

org.apache.commons.collections4.list.TransformedList<E>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>

public class TransformedList<E>
extends TransformedCollection<E>
implements java.util.List<E>

Decorates another List to transform objects that are added.

The add and set methods are affected by this class. Thus objects must be removed or searched for using their transformed form. For example, if the transformation converts Strings to Integers, you must use the Integer form to remove objects.

This class is Serializable from Commons Collections 3.1.

Since:

3.0

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	add(int index, E object)
boolean	addAll(int index, java.util.Collection<? extends E> coll)
boolean	equals(java.lang.Object object)
E	get(int index)
int	hashCode()
int	indexOf(java.lang.Object object)
int	lastIndexOf(java.lang.Object object)
java.util.ListIterator<E>	listIterator()
java.util.ListIterator<E>	listIterator(int i)
E	remove(int index)
E	set(int index, E object)
java.util.List<E>	subList(int fromIndex, int toIndex)
static <E> TransformedList<E>	transformedList(java.util.List<E> list, Transformer<? super E,? extends E> transformer) Factory method to create a transforming list that will transform existing contents of the specified list.
static <E> TransformedList<E>	transformingList(java.util.List<E> list, Transformer<? super E,? extends E> transformer) Factory method to create a transforming list.

Methods inherited from class org.apache.commons.collections4.collection.TransformedCollection

add, addAll, transformedCollection, transformingCollection

Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator

clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, replaceAll, retainAll, size, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

transformingList

public static <E> TransformedList<E> transformingList(java.util.List<E> list,
                                                      Transformer<? super E,? extends E> transformer)

Factory method to create a transforming list.

If there are any elements already in the list being decorated, they are NOT transformed. Contrast this with transformedList(List, Transformer).

Type Parameters:

E - the type of the elements in the list

Parameters:

list - the list to decorate, must not be null

transformer - the transformer to use for conversion, must not be null

Returns:

a new transformed list

Throws:

java.lang.NullPointerException - if list or transformer is null

Since:

4.0

transformedList

public static <E> TransformedList<E> transformedList(java.util.List<E> list,
                                                     Transformer<? super E,? extends E> transformer)

Factory method to create a transforming list that will transform existing contents of the specified list.

If there are any elements already in the list being decorated, they will be transformed by this method. Contrast this with transformingList(List, Transformer).

Type Parameters:

E - the type of the elements in the list

Parameters:

list - the list to decorate, must not be null

transformer - the transformer to use for conversion, must not be null

Returns:

a new transformed List

Throws:

java.lang.NullPointerException - if list or transformer is null

Since:

4.0

equals

public boolean equals(java.lang.Object object)

Specified by:

equals in interface java.util.Collection<E>

Specified by:

equals in interface java.util.List<E>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<E>

Specified by:

hashCode in interface java.util.List<E>

Overrides:

hashCode in class java.lang.Object

get

public E get(int index)

Specified by:

get in interface java.util.List<E>

indexOf

public int indexOf(java.lang.Object object)

Specified by:

indexOf in interface java.util.List<E>

lastIndexOf

public int lastIndexOf(java.lang.Object object)

Specified by:

lastIndexOf in interface java.util.List<E>

remove

public E remove(int index)

Specified by:

remove in interface java.util.List<E>

add

public void add(int index,
                E object)

Specified by:

add in interface java.util.List<E>

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends E> coll)

Specified by:

addAll in interface java.util.List<E>

listIterator

public java.util.ListIterator<E> listIterator()

Specified by:

listIterator in interface java.util.List<E>

listIterator

public java.util.ListIterator<E> listIterator(int i)

Specified by:

listIterator in interface java.util.List<E>

set

public E set(int index,
             E object)

Specified by:

set in interface java.util.List<E>

subList

public java.util.List<E> subList(int fromIndex,
                                 int toIndex)

Specified by:

subList in interface java.util.List<E>