mods.thecomputerizer.theimpossiblelibrary.api.iterator

Class Wrapperable<E>

java.lang.Object

mods.thecomputerizer.theimpossiblelibrary.api.iterator.Wrapperable<E>

All Implemented Interfaces:

java.lang.Iterable<E>

public class Wrapperable<E>
extends java.lang.Object
implements java.lang.Iterable<E>

Wrapper used for bundling generic helper methods with a final Iterable instance

Constructor Summary

Constructors

Constructor and Description
Wrapperable(java.lang.Iterable<E> iterable, boolean isSynchronized)

Method Summary

Modifier and Type	Method and Description
void	add(E element)
void	add(int index, E element) This may have weird results if the collection instance does not preserve order
void	addAll(java.lang.Iterable<E> other)
void	clear()
Wrapperable<E>	copyNotMatching(java.util.function.Supplier<Wrapperable<E>> supplier, java.util.function.Function<E,java.lang.Boolean> matcher)
protected java.lang.Iterable<E>	fixInstance(java.lang.Iterable<E> itr) Handles checking the instance of iterators that may be wrapperable or mappable instances This is done so the instanceof Collection checks do not fail when they should not
void	forEach(java.util.function.Consumer<? super E> action)
java.util.Collection<E>	get()
E	get(int index)
java.util.List<E>	getAsList()
java.util.List<E>	getAsList(java.util.function.Function<Wrapperable<E>,? extends java.util.List<E>> onCastException)
java.util.Set<E>	getAsSet()
java.util.Set<E>	getAsSet(java.util.function.Function<Wrapperable<E>,? extends java.util.Set<E>> onCastException)
java.util.List<E>	getAsSynchronizedList()
java.util.List<E>	getAsSynchronizedList(java.util.function.Function<Wrapperable<E>,? extends java.util.List<E>> onCastException)
<T extends java.util.Collection<E>> T	getAsType(java.lang.Class<T> clazz)
<T extends java.util.Collection<E>> T	getAsType(java.lang.Class<T> clazz, @Nullable java.util.function.Function<Wrapperable<E>,? extends java.util.Collection<E>> onCastException) Syntactic sugar...
java.lang.Class<?>	getElementClass()
E	getFirstEquals(@Nullable java.lang.Iterable<E> otherItr) Runs getFirstMatching with Objects#equals as the matcherFunc
E	getFirstMatching(@Nullable java.lang.Iterable<E> otherItr, java.util.function.BiFunction<E,E,java.lang.Boolean> matcherFunc) Iterates through the other iterable for each element of the wrapped iterable and returns the matching element.
E	getNonNullElement() Gets the first element in the collection that is not null.
void	insertMatching(java.util.Collection<E> output, java.util.function.Function<E,java.lang.Boolean> matcher)
<C extends java.util.Collection<E>> C	insertMatching(java.util.function.Supplier<C> outputSupplier, java.util.function.Function<E,java.lang.Boolean> matcher)
boolean	isEmpty()
boolean	isList()
boolean	isNotEmpty()
boolean	isSet()
boolean	isUnique()
@NotNull java.util.Iterator<E>	iterator()
static <E> Wrapperable<E>	make(java.util.function.Supplier<java.lang.Iterable<E>> supplier) Helper method for iterable suppliers
static <E> Wrapperable<E>	make(java.util.function.Supplier<java.lang.Iterable<E>> supplier, java.util.function.Consumer<Wrapperable<E>> settings)
static <E> Wrapperable<E>	makeArray(java.util.function.Consumer<Wrapperable<E>> settings, E... elements)
static <E> Wrapperable<E>	makeArray(E... elements) Array versions of the make methods
static <E> Wrapperable<E>	makeArray(java.util.function.Supplier<E[]> supplier)
static <E> Wrapperable<E>	makeArray(java.util.function.Supplier<E[]> supplier, java.util.function.Consumer<Wrapperable<E>> settings)
static <E> Wrapperable<E>	makeSynchronized(java.util.function.Supplier<java.lang.Iterable<E>> supplier) Synchronized versions of the make methods
static <E> Wrapperable<E>	makeSynchronized(java.util.function.Supplier<java.lang.Iterable<E>> supplier, java.util.function.Consumer<Wrapperable<E>> settings)
static <E> Wrapperable<E>	makeSynchronizedArray(java.util.function.Consumer<Wrapperable<E>> settings, E... elements)
static <E> Wrapperable<E>	makeSynchronizedArray(E... elements) Synchronized versions of the makeArray methods
static <E> Wrapperable<E>	makeSynchronizedArray(java.util.function.Supplier<E[]> supplier)
static <E> Wrapperable<E>	makeSynchronizedArray(java.util.function.Supplier<E[]> supplier, java.util.function.Consumer<Wrapperable<E>> settings)
<M> Wrapperable<M>	map(java.util.function.Supplier<Wrapperable<M>> supplier, java.util.function.Function<E,M> mapper)
<M> void	mapTo(java.util.Collection<M> c, java.util.function.Function<E,M> mapper, boolean clearExisting, boolean removeNulls)
<M,C extends java.util.Collection<M>> C	mapTo(java.util.function.Supplier<C> supplier, java.util.function.Function<E,M> mapper, boolean removeNulls)
<M> void	mapTo(Wrapperable<M> w, java.util.function.Function<E,M> mapper, boolean clearExisting, boolean removeNulls)
java.util.stream.Stream<E>	parallelStream()
void	remove(E element)
void	removeAll(java.lang.Iterable<E> other)
boolean	removeIf(java.util.function.Predicate<? super E> filter)
void	removeIndex(int index) This may have weird results if the collection instance does not preserve order or if the elements are integers
void	set(boolean clearExisting, E... elements)
void	set(boolean clearExisting, java.lang.Iterable<E> elements)
void	set(E... elements)
void	set(java.lang.Iterable<E> elements)
int	size()
java.util.Spliterator<E>	spliterator()
java.util.stream.Stream<E>	stream()
E[]	toArray()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Wrapperable

public Wrapperable(java.lang.Iterable<E> iterable,
                   boolean isSynchronized)

Method Detail

make

public static <E> Wrapperable<E> make(java.util.function.Supplier<java.lang.Iterable<E>> supplier)

Helper method for iterable suppliers

make

public static <E> Wrapperable<E> make(java.util.function.Supplier<java.lang.Iterable<E>> supplier,
                                      java.util.function.Consumer<Wrapperable<E>> settings)

makeSynchronized

public static <E> Wrapperable<E> makeSynchronized(java.util.function.Supplier<java.lang.Iterable<E>> supplier)

Synchronized versions of the make methods

makeSynchronized

public static <E> Wrapperable<E> makeSynchronized(java.util.function.Supplier<java.lang.Iterable<E>> supplier,
                                                  java.util.function.Consumer<Wrapperable<E>> settings)

makeArray

public static <E> Wrapperable<E> makeArray(E... elements)

Array versions of the make methods

makeArray

public static <E> Wrapperable<E> makeArray(java.util.function.Consumer<Wrapperable<E>> settings,
                                           E... elements)

makeArray

public static <E> Wrapperable<E> makeArray(java.util.function.Supplier<E[]> supplier)

makeArray

public static <E> Wrapperable<E> makeArray(java.util.function.Supplier<E[]> supplier,
                                           java.util.function.Consumer<Wrapperable<E>> settings)

makeSynchronizedArray

public static <E> Wrapperable<E> makeSynchronizedArray(E... elements)

Synchronized versions of the makeArray methods

makeSynchronizedArray

public static <E> Wrapperable<E> makeSynchronizedArray(java.util.function.Consumer<Wrapperable<E>> settings,
                                                       E... elements)

makeSynchronizedArray

public static <E> Wrapperable<E> makeSynchronizedArray(java.util.function.Supplier<E[]> supplier)

makeSynchronizedArray

public static <E> Wrapperable<E> makeSynchronizedArray(java.util.function.Supplier<E[]> supplier,
                                                       java.util.function.Consumer<Wrapperable<E>> settings)

add

public void add(E element)

add

public void add(int index,
                E element)

This may have weird results if the collection instance does not preserve order

addAll

public void addAll(java.lang.Iterable<E> other)

clear

public void clear()

copyNotMatching

public Wrapperable<E> copyNotMatching(java.util.function.Supplier<Wrapperable<E>> supplier,
                                      java.util.function.Function<E,java.lang.Boolean> matcher)

fixInstance

protected java.lang.Iterable<E> fixInstance(java.lang.Iterable<E> itr)

Handles checking the instance of iterators that may be wrapperable or mappable instances This is done so the instanceof Collection checks do not fail when they should not

forEach

public void forEach(java.util.function.Consumer<? super E> action)

Specified by:

forEach in interface java.lang.Iterable<E>

get

public java.util.Collection<E> get()

get

@Nullable
public E get(int index)

getAsList

public java.util.List<E> getAsList()
                            throws java.lang.ClassCastException

Throws:

java.lang.ClassCastException

getAsList

public java.util.List<E> getAsList(java.util.function.Function<Wrapperable<E>,? extends java.util.List<E>> onCastException)

getAsSynchronizedList

public java.util.List<E> getAsSynchronizedList()
                                        throws java.lang.ClassCastException

Throws:

java.lang.ClassCastException

getAsSynchronizedList

public java.util.List<E> getAsSynchronizedList(java.util.function.Function<Wrapperable<E>,? extends java.util.List<E>> onCastException)

getAsSet

public java.util.Set<E> getAsSet()
                          throws java.lang.ClassCastException

Throws:

java.lang.ClassCastException

getAsSet

public java.util.Set<E> getAsSet(java.util.function.Function<Wrapperable<E>,? extends java.util.Set<E>> onCastException)

getAsType

public <T extends java.util.Collection<E>> T getAsType(java.lang.Class<T> clazz)
                                                throws java.lang.ClassCastException

Throws:

java.lang.ClassCastException

getAsType

public <T extends java.util.Collection<E>> T getAsType(java.lang.Class<T> clazz,
                                                       @Nullable
                                                       @Nullable java.util.function.Function<Wrapperable<E>,? extends java.util.Collection<E>> onCastException)

Syntactic sugar...

getElementClass

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

getFirstEquals

@Nullable
public E getFirstEquals(@Nullable
                                   @Nullable java.lang.Iterable<E> otherItr)

Runs getFirstMatching with Objects#equals as the matcherFunc

getFirstMatching

@Nullable
public E getFirstMatching(@Nullable
                                     @Nullable java.lang.Iterable<E> otherItr,
                                     java.util.function.BiFunction<E,E,java.lang.Boolean> matcherFunc)

Iterates through the other iterable for each element of the wrapped iterable and returns the matching element. Both iterables are assumed to be ordered or the result may be inconsistent

getNonNullElement

@Nullable
public E getNonNullElement()

Gets the first element in the collection that is not null. Returns null if nothing is found

insertMatching

public void insertMatching(java.util.Collection<E> output,
                           java.util.function.Function<E,java.lang.Boolean> matcher)

insertMatching

public <C extends java.util.Collection<E>> C insertMatching(java.util.function.Supplier<C> outputSupplier,
                                                            java.util.function.Function<E,java.lang.Boolean> matcher)

isEmpty

public boolean isEmpty()

isList

public boolean isList()

isNotEmpty

public boolean isNotEmpty()

isSet

public boolean isSet()

isUnique

public boolean isUnique()

iterator

@NotNull
public @NotNull java.util.Iterator<E> iterator()

Specified by:

iterator in interface java.lang.Iterable<E>

map

public <M> Wrapperable<M> map(java.util.function.Supplier<Wrapperable<M>> supplier,
                              java.util.function.Function<E,M> mapper)

mapTo

public <M> void mapTo(Wrapperable<M> w,
                      java.util.function.Function<E,M> mapper,
                      boolean clearExisting,
                      boolean removeNulls)

mapTo

public <M> void mapTo(java.util.Collection<M> c,
                      java.util.function.Function<E,M> mapper,
                      boolean clearExisting,
                      boolean removeNulls)

mapTo

public <M,C extends java.util.Collection<M>> C mapTo(java.util.function.Supplier<C> supplier,
                                                     java.util.function.Function<E,M> mapper,
                                                     boolean removeNulls)

parallelStream

public java.util.stream.Stream<E> parallelStream()

remove

public void remove(E element)

removeIf

public boolean removeIf(java.util.function.Predicate<? super E> filter)

removeAll

public void removeAll(java.lang.Iterable<E> other)

removeIndex

public void removeIndex(int index)

This may have weird results if the collection instance does not preserve order or if the elements are integers

set

public final void set(E... elements)

set

public final void set(boolean clearExisting,
                      E... elements)

set

public void set(java.lang.Iterable<E> elements)

set

public void set(boolean clearExisting,
                java.lang.Iterable<E> elements)

size

public int size()

spliterator

public java.util.Spliterator<E> spliterator()

Specified by:

spliterator in interface java.lang.Iterable<E>

stream

public java.util.stream.Stream<E> stream()

toArray

public E[] toArray()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object