mods.thecomputerizer.theimpossiblelibrary.api.iterator

Class IterableHelper

java.lang.Object

mods.thecomputerizer.theimpossiblelibrary.api.iterator.IterableHelper

public class IterableHelper
extends java.lang.Object

Helper methods, for instances of iterators, iterables, and maps

Constructor Summary

Constructors

Constructor and Description
IterableHelper()

Method Summary

Modifier and Type	Method and Description
static <E> int	count(java.lang.Iterable<E> itr)
static <E> int	count(java.util.Iterator<E> itr) This will consume the iterator, so use it with caution!
static <E> int	countOccurances(E occurance, java.lang.Iterable<E> itr)
static <E> int	countOccurances(E occurance, java.util.Iterator<E> itr)
static <E> E	getElement(int index, java.lang.Iterable<E> itr) Does not verify ordering!
static <E> E	getElement(int index, java.util.Iterator<E> itr) Does not verify ordering!
static <E> E	getElementOrDefault(int index, E defaultVal, java.lang.Iterable<E> itr) Does not verify ordering!
static <E> E	getElementOrDefault(int index, E defaultVal, java.util.Iterator<E> itr) Does not verify ordering!
static <E> E	getElementOrNull(int index, java.lang.Iterable<E> itr) Does not verify ordering!
static <E> E	getElementOrNull(int index, java.util.Iterator<E> itr) Does not verify ordering!
static int[]	getLengths(java.lang.Iterable<?> itr) Iterates over the input iterable while checking if there are any iterable or iterator elements.
static int[]	getLengths(java.util.Iterator<?> itr) Iterates over the input while checking if there are any iterable or iterator elements.
static <K,V> java.util.Map.Entry<K,V>	getMapEntry(K key, V val)
static <K,V> java.util.Map.Entry<K,V>	getMapEntry(K key, V val, boolean mutable)
static boolean	matches(@Nullable java.lang.Iterable<?> itr, @Nullable java.lang.Object value) Runs non-strict equality rules.
static boolean	matches(@Nullable java.util.Iterator<?> itr, @Nullable java.lang.Object value) Runs non-strict equality rules.
static boolean	matchesArray(@Nullable java.lang.Iterable<?> itr, @Nullable java.lang.Object[] array) Runs non-strict equality rules.
static boolean	matchesArray(@Nullable java.util.Iterator<?> itr, @Nullable java.lang.Object[] array) Runs non-strict equality rules.
static boolean	matchesItr(@Nullable java.lang.Iterable<?> itr, @Nullable java.lang.Iterable<?> other) Runs non-strict equality rules.
static boolean	matchesItr(@Nullable java.lang.Iterable<?> itr, @Nullable java.util.Iterator<?> other) Runs non-strict equality rules.
static boolean	matchesItr(@Nullable java.util.Iterator<?> itr, @Nullable java.util.Iterator<?> other) Runs non-strict equality rules.

Methods inherited from class java.lang.Object

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

Constructor Detail

IterableHelper

public IterableHelper()

Method Detail

count

public static <E> int count(java.lang.Iterable<E> itr)

count

public static <E> int count(java.util.Iterator<E> itr)

This will consume the iterator, so use it with caution!

countOccurances

public static <E> int countOccurances(E occurance,
                                      java.lang.Iterable<E> itr)

countOccurances

public static <E> int countOccurances(E occurance,
                                      java.util.Iterator<E> itr)

getElement

public static <E> E getElement(int index,
                               java.lang.Iterable<E> itr)
                        throws java.lang.IndexOutOfBoundsException

Does not verify ordering!

Throws:

java.lang.IndexOutOfBoundsException

getElement

public static <E> E getElement(int index,
                               java.util.Iterator<E> itr)
                        throws java.lang.IndexOutOfBoundsException

Does not verify ordering!

Throws:

java.lang.IndexOutOfBoundsException

getElementOrDefault

@Nullable
public static <E> E getElementOrDefault(int index,
                                                   E defaultVal,
                                                   java.lang.Iterable<E> itr)

Does not verify ordering!

getElementOrDefault

public static <E> E getElementOrDefault(int index,
                                        E defaultVal,
                                        java.util.Iterator<E> itr)

Does not verify ordering!

getElementOrNull

@Nullable
public static <E> E getElementOrNull(int index,
                                                java.lang.Iterable<E> itr)

Does not verify ordering!

getElementOrNull

@Nullable
public static <E> E getElementOrNull(int index,
                                                java.util.Iterator<E> itr)

Does not verify ordering!

getLengths

public static int[] getLengths(java.lang.Iterable<?> itr)

Iterates over the input iterable while checking if there are any iterable or iterator elements. If an iterable or iterator is found then the size of the largest will be used as the next length

getLengths

public static int[] getLengths(java.util.Iterator<?> itr)

Iterates over the input while checking if there are any iterable or iterator elements. If an iterable or iterator is found then the size of the largest will be used as the next length

getMapEntry

public static <K,V> java.util.Map.Entry<K,V> getMapEntry(K key,
                                                         V val)

getMapEntry

public static <K,V> java.util.Map.Entry<K,V> getMapEntry(K key,
                                                         V val,
                                                         boolean mutable)

matches

public static boolean matches(@Nullable
                              @Nullable java.lang.Iterable<?> itr,
                              @Nullable
                              @Nullable java.lang.Object value)

Runs non-strict equality rules. If both inputs are null, they are considered matching. If the value is an instance of an array, iterable, or iterator, further matching rules are applied. If the iterable only has one element that matches the value, they are considered matching

matches

public static boolean matches(@Nullable
                              @Nullable java.util.Iterator<?> itr,
                              @Nullable
                              @Nullable java.lang.Object value)

Runs non-strict equality rules. If both inputs are null, they are considered matching. If the value is an instance of an array, iterable, or iterator, further matching rules are applied. If the iterator only has one element that matches the value, they are considered matching

matchesArray

public static boolean matchesArray(@Nullable
                                   @Nullable java.lang.Iterable<?> itr,
                                   @Nullable
                                   @Nullable java.lang.Object[] array)

Runs non-strict equality rules. If both inputs are null, they are considered matching. If the iterable has the same number of elements as the array, matching rules are run for each element. Ordering of the iterable instance is not guaranteed.

matchesArray

public static boolean matchesArray(@Nullable
                                   @Nullable java.util.Iterator<?> itr,
                                   @Nullable
                                   @Nullable java.lang.Object[] array)

Runs non-strict equality rules. If both inputs are null, they are considered matching. If the iterable only has one element that matches the value, they are considered matching If the value is an instance of an array or other iterable further matching rules are applied.

matchesItr

public static boolean matchesItr(@Nullable
                                 @Nullable java.lang.Iterable<?> itr,
                                 @Nullable
                                 @Nullable java.lang.Iterable<?> other)

Runs non-strict equality rules. If both inputs are null, they are considered matching. If the iterable only has one element that matches the value, they are considered matching If the value is an instance of an array or other iterable further matching rules are applied.

matchesItr

public static boolean matchesItr(@Nullable
                                 @Nullable java.lang.Iterable<?> itr,
                                 @Nullable
                                 @Nullable java.util.Iterator<?> other)

Runs non-strict equality rules. If both inputs are null, they are considered matching. If the iterable only has one element that matches the value, they are considered matching If the value is an instance of an array or other iterable further matching rules are applied.

matchesItr

public static boolean matchesItr(@Nullable
                                 @Nullable java.util.Iterator<?> itr,
                                 @Nullable
                                 @Nullable java.util.Iterator<?> other)

Runs non-strict equality rules. If both inputs are null, they are considered matching. If the iterable only has one element that matches the value, they are considered matching If the value is an instance of an array or other iterable further matching rules are applied.