org.openzen.zengarden.collections

Interface ZCollection<T>

Type Parameters:

T - element type

All Superinterfaces:

java.lang.Iterable<T>

All Known Subinterfaces:

WatchedList<T>, ZList<T>

All Known Implementing Classes:

BasicWatchedList, ZArrayList, ZFixedList, ZMappedCollection

public interface ZCollection<T>
extends java.lang.Iterable<T>

Custom alternative to a Collection. Intended to fix some of the ugliness of the standard Collections.

Method Summary

Modifier and Type	Method and Description
boolean	add(T value) Adds an element to the collection.
default boolean	addAll(java.lang.Iterable<? extends T> c) Adds all the objects from the given collection to this collection.
void	clear() Removes all elements from this collection.
boolean	contains(T value) Checks if the collection contains the given element.
default boolean	containsAll(java.lang.Iterable<? extends T> c) Checks if this collection contains all the elements of the given collection.
default ZCollection<T>	filter(Predicate<T> predicate) Returns a copy of this collection, containing all values that match the given filter.
java.lang.Class<T>	getElementClass() Returns the collection's element class.
default boolean	isEmpty() Checks if this collection is empty.
default <U> ZCollection<U>	map(java.lang.Class<U> type, Function<T,U> converter) Returns a copy of this collection, containing all original values converted with the given function.
default <U> ZCollection<U>	mapLive(java.lang.Class<U> type, Function<T,U> converter) Returns a live (unidirectionally updated) collection of values.
default <U> ZCollection<U>	mapLive(java.lang.Class<U> type, Function<T,U> converter, Function<U,T> backwardsConverter) Returns a live (bidirectionally updated) collection of values.
default <U> U	reduce(BiFunction<U,T,U> reductor, U initialValue) Performs a reduce operation on this collection, that is, it updates the initial value repeatedly with the reduction function to return a single value.
boolean	remove(T value) Removes an element from the collection.
default boolean	removeAll(java.lang.Iterable<? extends T> c) Removes all the objects from the given collection from this collection.
int	size() Returns the size of this collection.
default T[]	toArray() Converts this collection to an array.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getElementClass

java.lang.Class<T> getElementClass()

Returns the collection's element class.

Returns:

element class

add

boolean add(T value)

Adds an element to the collection.

Parameters:

value - value to be added

Returns:

true if the collection has been modified

remove

boolean remove(T value)

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

Parameters:

value - value to be removed

Returns:

true if the collection has been modified, false otherwise

contains

boolean contains(T value)

Checks if the collection contains the given element.

Parameters:

value - value to check the collection for

Returns:

true if the element is in the collection, false otherwise

addAll

default boolean addAll(java.lang.Iterable<? extends T> c)

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

Parameters:

c - collection of elements to add

Returns:

true if this collection has been modified, false otherwise

removeAll

default boolean removeAll(java.lang.Iterable<? extends T> c)

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

Parameters:

c - collection of elements to remove

Returns:

true if this collection has been modified, false otherwise

containsAll

default boolean containsAll(java.lang.Iterable<? extends T> c)

Checks if this collection contains all the elements of the given collection.

Parameters:

c - collection to check for

Returns:

true if this collection contains all given elements, false otherwise

size

int size()

Returns the size of this collection.

Returns:

collection size

clear

void clear()

Removes all elements from this collection.

isEmpty

default boolean isEmpty()

Checks if this collection is empty.

Returns:

true if empty, false otherwise

toArray

default T[] toArray()

Converts this collection to an array.

Returns:

an array containing all elements in this collection

mapLive

default <U> ZCollection<U> mapLive(java.lang.Class<U> type,
                                   Function<T,U> converter)

Returns a live (unidirectionally updated) collection of values. All values in the original collection will be converted with the given convertor.

Type Parameters:

U - resulting element type

Parameters:

type - element class

converter - converter to use

Returns:

unidirectionally mapped collection

mapLive

default <U> ZCollection<U> mapLive(java.lang.Class<U> type,
                                   Function<T,U> converter,
                                   Function<U,T> backwardsConverter)

Returns a live (bidirectionally updated) collection of values. All values in the original collection will be converted with the given convertors.

Type Parameters:

U - resulting element type

Parameters:

type - element class

converter - convertor from original to new type

backwardsConverter - convertor from new to original type

Returns:

bidirectionally mapped collection

map

default <U> ZCollection<U> map(java.lang.Class<U> type,
                               Function<T,U> converter)

Returns a copy of this collection, containing all original values converted with the given function.

Type Parameters:

U - resulting element type

Parameters:

type - element class

converter - conversion function

Returns:

collection copy

filter

default ZCollection<T> filter(Predicate<T> predicate)

Returns a copy of this collection, containing all values that match the given filter.

Parameters:

predicate - predicate to use

Returns:

filtered collection

reduce

default <U> U reduce(BiFunction<U,T,U> reductor,
                     U initialValue)

Performs a reduce operation on this collection, that is, it updates the initial value repeatedly with the reduction function to return a single value.

Type Parameters:

U - result type

Parameters:

reductor - reduction function

initialValue - initial value

Returns:

reduced value