org.openzen.zengarden.collections

Class ZMappedCollection<T,U>

java.lang.Object

org.openzen.zengarden.collections.ZMappedCollection<T,U>

Type Parameters:

T - original type

U - mapped type

All Implemented Interfaces:

java.lang.Iterable<U>, ZCollection<U>

public class ZMappedCollection<T,U>
extends java.lang.Object
implements ZCollection<U>

Represents an unidirectionally or bidirectionally mapped collection. The mapped collection will contain all values in the original collection and, if a backwards function is provided, will be able to modify the original.

Constructor Summary

Constructors

Constructor and Description
ZMappedCollection(java.lang.Class<U> type, ZCollection<T> original, Function<T,U> function) Constructs an unidirectionally mapped collection.
ZMappedCollection(java.lang.Class<U> type, ZCollection<T> original, Function<T,U> function, Function<U,T> backwardsFunction) Constructs a bidirectionally mapped collection.

Method Summary

Modifier and Type	Method and Description
boolean	add(U e) Adds an element to the collection.
boolean	addAll(java.lang.Iterable<? extends U> c) Adds all the objects from the given collection to this collection.
void	clear() Removes all elements from this collection.
boolean	contains(U o) Checks if the collection contains the given element.
java.lang.Class<U>	getElementClass() Returns the collection's element class.
boolean	isEmpty() Checks if this collection is empty.
java.util.Iterator<U>	iterator()
boolean	remove(U o) Removes an element from the collection.
boolean	removeAll(java.lang.Iterable<? extends U> c) Removes all the objects from the given collection from this collection.
int	size() Returns the size of this collection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openzen.zengarden.collections.ZCollection

addAll, containsAll, count, filter, has, map, mapLive, mapLive, reduce, removeAll, sum, sum, toArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ZMappedCollection

public ZMappedCollection(java.lang.Class<U> type,
                         ZCollection<T> original,
                         Function<T,U> function)

Constructs an unidirectionally mapped collection. This collection will contain all values of the given collection, but the add, remove and contains methods (and addAll, removeAll and containsAll) will not work. Note that the clear() method still works; an unidirectionally mapped array is not immutable.

Parameters:

type - element type

original - original collection

function - mapping function

ZMappedCollection

public ZMappedCollection(java.lang.Class<U> type,
                         ZCollection<T> original,
                         Function<T,U> function,
                         Function<U,T> backwardsFunction)

Constructs a bidirectionally mapped collection. This collection will contain all values of the given collection. If this collection has been modified, the original collection will be modified with it.

Parameters:

type - element type

original - original collection

function - mapping function (from original to new type)

backwardsFunction - backwards function (from new type to original)

Method Detail

getElementClass

public java.lang.Class<U> getElementClass()

Description copied from interface: ZCollection

Returns the collection's element class.

Specified by:

getElementClass in interface ZCollection<U>

Returns:

element class

size

public int size()

Description copied from interface: ZCollection

Returns the size of this collection.

Specified by:

size in interface ZCollection<U>

Returns:

collection size

isEmpty

public boolean isEmpty()

Description copied from interface: ZCollection

Checks if this collection is empty.

Specified by:

isEmpty in interface ZCollection<U>

Returns:

true if empty, false otherwise

iterator

public java.util.Iterator<U> iterator()

Specified by:

iterator in interface java.lang.Iterable<U>

add

public boolean add(U e)

Description copied from interface: ZCollection

Adds an element to the collection.

Specified by:

add in interface ZCollection<U>

Parameters:

e - value to be added

Returns:

true if the collection has been modified

remove

public boolean remove(U o)

Description copied from interface: ZCollection

Removes an element from the collection. Does nothing if the collection doesn't contain the given element.

Specified by:

remove in interface ZCollection<U>

Parameters:

o - value to be removed

Returns:

true if the collection has been modified, false otherwise

contains

public boolean contains(U o)

Description copied from interface: ZCollection

Checks if the collection contains the given element.

Specified by:

contains in interface ZCollection<U>

Parameters:

o - value to check the collection for

Returns:

true if the element is in the collection, false otherwise

addAll

public boolean addAll(java.lang.Iterable<? extends U> c)

Description copied from interface: ZCollection

Adds all the objects from the given collection to this collection.

Specified by:

addAll in interface ZCollection<U>

Parameters:

c - collection of elements to add

Returns:

true if this collection has been modified, false otherwise

removeAll

public boolean removeAll(java.lang.Iterable<? extends U> c)

Description copied from interface: ZCollection

Removes all the objects from the given collection from this collection.

Specified by:

removeAll in interface ZCollection<U>

Parameters:

c - collection of elements to remove

Returns:

true if this collection has been modified, false otherwise

clear

public void clear()

Description copied from interface: ZCollection

Removes all elements from this collection.

Specified by:

clear in interface ZCollection<U>