| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public boolean | allSatisfy(Predicate<? super V> predicate)
Implements org. Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty. |
| public <P> boolean | allSatisfyWith(Predicate2<? super V, ? super P> predicate, P parameter)
Implements org. Returns true if the predicate evaluates to true for every element of the collection, or returns false. |
| public boolean | anySatisfy(Predicate<? super V> predicate)
Implements org. Returns true if the predicate evaluates to true for any element of the iterable. |
| public <P> boolean | anySatisfyWith(Predicate2<? super V, ? super P> predicate, P parameter)
Implements org. Returns true if the predicate evaluates to true for any element of the collection, or return false. |
| public void | appendString(Appendable appendable)
Overrides default org. Prints a string representation of this collection onto the given |
| public void | appendString(Appendable appendable, String separator)
Overrides default org. Prints a string representation of this collection onto the given |
| public void | appendString(Appendable appendable, String start, String separator, String end)
Implements org. Prints a string representation of this collection onto the given |
| public LazyIterable | asLazy()
Implements org. Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this). |
| public RichIterable | chunk(int size)
Implements org. Partitions elements in fixed size chunks. |
| public <VV, R extends Collection | collect(Function<? super V, ? extends VV> function, R target)
Implements org. Same as |
| public <R extends MutableBooleanCollection> R | collectBoolean(BooleanFunction<? super V> booleanFunction, R target)
Overrides default org. Same as |
| public <R extends MutableByteCollection> R | collectByte(ByteFunction<? super V> byteFunction, R target)
Overrides default org. Same as |
| public <R extends MutableCharCollection> R | collectChar(CharFunction<? super V> charFunction, R target)
Overrides default org. Same as |
| public <R extends MutableDoubleCollection> R | collectDouble(DoubleFunction<? super V> doubleFunction, R target)
Overrides default org. Same as |
| public <R extends MutableFloatCollection> R | collectFloat(FloatFunction<? super V> floatFunction, R target)
Overrides default org. Same as |
| public <VV, R extends Collection | collectIf(Predicate<? super V> predicate, Function<? super V, ? extends VV> function, R target)
Implements org. Same as the collectIf method with two parameters but uses the specified target collection for the results. |
| public <R extends MutableIntCollection> R | collectInt(IntFunction<? super V> intFunction, R target)
Overrides default org. Same as |
| public <R extends MutableLongCollection> R | collectLong(LongFunction<? super V> longFunction, R target)
Overrides default org. Same as |
| public <R extends MutableShortCollection> R | collectShort(ShortFunction<? super V> shortFunction, R target)
Overrides default org. Same as |
| public <P, VV, R extends Collection | collectWith(Function2<? super V, ? super P, ? extends VV> function, P parameter, R targetCollection)
Implements org. Same as collectWith but with a targetCollection parameter to gather the results. |
| public boolean | contains(Object object)
Implements org. Returns true if the iterable has an element which responds true to element.equals(object). |
| public boolean | containsAll(Collection<?> source)
Implements org. Returns true if all elements in source are contained in this collection. |
| public boolean | containsAllArguments(Object... elements)
Implements org. Returns true if all elements in the specified var arg array are contained in this collection. |
| public boolean | containsAllIterable(Iterable<?> source)
Implements org. Returns true if all elements in source are contained in this collection. |
| public boolean | |
| public boolean | |
| public int | count(Predicate<? super V> predicate)
Implements org. Return the total number of elements that answer true to the specified predicate. |
| public <P> int | countWith(Predicate2<? super V, ? super P> predicate, P parameter)
Implements org. Returns the total number of elements that evaluate to true for the specified predicate. |
| public Pair | detect(Predicate2<? super K, ? super V> predicate)
Implements org. Return the first key and value of the map for which the predicate evaluates to true when they are given as arguments. |
| public V | detect(Predicate<? super V> predicate)
Implements org. Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true. |
| public V | detectIfNone(Predicate<? super V> predicate, Function0<? extends V> function)
Overrides default org. Returns the first element of the iterable for which the predicate evaluates to true. |
| public Optional | detectOptional(Predicate2<? super K, ? super V> predicate)
Implements org. Return the first key and value of the map as an Optional for which the predicate evaluates to true when they are given as arguments. |
| public Optional | detectOptional(Predicate<? super V> predicate)
Implements org. Returns the first element of the iterable for which the predicate evaluates to true as an Optional. |
| public <P> V | detectWith(Predicate2<? super V, ? super P> predicate, P parameter)
Implements org. Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true. |
| public <P> V | detectWithIfNone(Predicate2<? super V, ? super P> predicate, P parameter, Function0<? extends V> function)
Implements org. Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function. |
| public <P> Optional | detectWithOptional(Predicate2<? super V, ? super P> predicate, P parameter)
Implements org. Returns the first element that evaluates to true for the specified predicate2 and parameter as an Optional. |
| public void | each(Procedure<? super V> procedure)
Implements org. The procedure is executed for each element in the iterable. |
| public boolean | equals(Object obj)
Overrides java. Implements org. Follows the same general contract as |
| public <VV, R extends Collection | flatCollect(Function<? super V, ? extends Iterable<VV>> function, R target)
Implements org. Same as flatCollect, only the results are collected into the target collection. |
| public <R extends MutableBooleanCollection> R | flatCollectBoolean(Function<? super V, ? extends BooleanIterable> function, R target)
Overrides default org. Same as flatCollect, only the results are collected into the target collection. |
| public <R extends MutableByteCollection> R | flatCollectByte(Function<? super V, ? extends ByteIterable> function, R target)
Overrides default org. Same as flatCollect, only the results are collected into the target collection. |
| public <R extends MutableCharCollection> R | flatCollectChar(Function<? super V, ? extends CharIterable> function, R target)
Overrides default org. Same as flatCollect, only the results are collected into the target collection. |
| public <R extends MutableDoubleCollection> R | flatCollectDouble(Function<? super V, ? extends DoubleIterable> function, R target)
Overrides default org. Same as flatCollect, only the results are collected into the target collection. |
| public <R extends MutableFloatCollection> R | flatCollectFloat(Function<? super V, ? extends FloatIterable> function, R target)
Overrides default org. Same as flatCollect, only the results are collected into the target collection. |
| public <R extends MutableIntCollection> R | flatCollectInt(Function<? super V, ? extends IntIterable> function, R target)
Overrides default org. Same as flatCollect, only the results are collected into the target collection. |
| public <R extends MutableLongCollection> R | flatCollectLong(Function<? super V, ? extends LongIterable> function, R target)
Overrides default org. Same as flatCollect, only the results are collected into the target collection. |
| public <R extends MutableShortCollection> R | flatCollectShort(Function<? super V, ? extends ShortIterable> function, R target)
Overrides default org. Same as flatCollect, only the results are collected into the target collection. |
| public void | forEachKey(Procedure<? super K> procedure)
Implements org. Calls the |
| public void | forEachKeyValue(Procedure2<? super K, ? super V> procedure)
Implements org. Calls the |
| public void | forEachValue(Procedure<? super V> procedure)
Implements org. Calls the procedure with each value of the map. |
| public <P> void | forEachWith(Procedure2<? super V, ? super P> procedure, P parameter)
Implements org. The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument. |
| public void | forEachWithIndex(ObjectIntProcedure<? super V> objectIntProcedure)
Implements org. Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure. |
| public V | |
| protected abstract MapIterable | |
| public V | getFirst()
Implements org. Returns the first element of an iterable. |
| public V | getIfAbsent(K key, Function0<? extends V> function)
Implements org. Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified Function0. |
| public V | getIfAbsentValue(K key, V value)
Implements org. Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return |
| public <P> V | getIfAbsentWith(K key, Function<? super P, ? extends V> function, P parameter)
Implements org. Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified function and parameter. |
| protected abstract MapIterable | |
| public V | getLast()
Implements org. Returns the last element of an iterable. |
| public V | getOnly()
Overrides default org. Returns the element if the iterable has exactly one element. |
| public V | getOrDefault(Object key, V defaultValue)
Overrides default org.
|
| public <VV, R extends MutableMultimap | groupBy(Function<? super V, ? extends VV> function, R target)
Implements org. Same as |
| public <VV, R extends MutableMultimap | groupByEach(Function<? super V, ? extends Iterable<VV>> function, R target)
Implements org. Same as |
| public <VV, R extends MutableMapIterable | groupByUniqueKey(Function<? super V, ? extends VV> function, R target)
Implements org. Same as |
| public int | hashCode()
Overrides java. Implements org. Follows the same general contract as |
| public <A> A | ifPresentApply(K key, Function<? super V, ? extends A> function)
Implements org. If there is a value in the Map that corresponds to the specified key return the result of applying the specified Function on the value, otherwise return null. |
| public <IV> IV | injectInto(IV injectedValue, Function2<? super IV, ? super V, ? extends IV> function)
Implements org. Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. |
| public int | injectInto(int injectedValue, IntObjectToIntFunction<? super V> function)
Implements org. Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. |
| public long | injectInto(long injectedValue, LongObjectToLongFunction<? super V> function)
Implements org. Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. |
| public float | injectInto(float injectedValue, FloatObjectToFloatFunction<? super V> function)
Implements org. Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. |
| public double | injectInto(double injectedValue, DoubleObjectToDoubleFunction<? super V> function)
Implements org. Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. |
| public <R extends Collection | into(R target)
Implements org. Adds all the elements in this iterable to the specific target Collection. |
| public boolean | isEmpty()
Implements org. Returns true if this iterable has zero items. |
| public RichIterable | keysView()
Implements org. Returns an unmodifiable lazy iterable wrapped around the keySet for the map. |
| public RichIterable | keyValuesView()
Implements org. Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map. |
| public String | makeString()
Overrides default org. Returns a string representation of this collection by delegating to |
| public String | makeString(String separator)
Overrides default org. Returns a string representation of this collection by delegating to |
| public String | makeString(String start, String separator, String end)
Overrides default org. Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings. |
| public V | max(Comparator<? super V> comparator)
Implements org. Returns the maximum element out of this container based on the comparator. |
| public V | max()
Implements org. Returns the maximum element out of this container based on the natural order. |
| public <VV extends Comparable | maxBy(Function<? super V, ? extends VV> function)
Implements org. Returns the maximum elements out of this container based on the natural order of the attribute returned by Function. |
| public V | min(Comparator<? super V> comparator)
Implements org. Returns the minimum element out of this container based on the comparator. |
| public V | min()
Implements org. Returns the minimum element out of this container based on the natural order. |
| public <VV extends Comparable | minBy(Function<? super V, ? extends VV> function)
Implements org. Returns the minimum elements out of this container based on the natural order of the attribute returned by Function. |
| public boolean | noneSatisfy(Predicate<? super V> predicate)
Implements org. Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty. |
| public <P> boolean | noneSatisfyWith(Predicate2<? super V, ? super P> predicate, P parameter)
Implements org. Returns true if the predicate evaluates to false for every element of the collection, or return false. |
| public boolean | notEmpty()
Overrides default org. The English equivalent of !this.isEmpty() |
| public <R extends Collection | reject(Predicate<? super V> predicate, R target)
Implements org. Same as the reject method with one parameter but uses the specified target collection for the results. |
| public <P, R extends Collection | rejectWith(Predicate2<? super V, ? super P> predicate, P parameter, R targetCollection)
Implements org. Similar to |
| public <R extends Collection | select(Predicate<? super V> predicate, R target)
Implements org. Same as the select method with one parameter but uses the specified target collection for the results. |
| public <P, R extends Collection | selectWith(Predicate2<? super V, ? super P> predicate, P parameter, R targetCollection)
Implements org. Similar to |
| public int | size()
Implements org. Returns the number of items in this iterable. |
| public double | sumOfDouble(DoubleFunction<? super V> function)
Implements org. Returns the final double result of evaluating function for each element of the iterable and adding the results together. |
| public double | sumOfFloat(FloatFunction<? super V> function)
Implements org. Returns the final double result of evaluating function for each element of the iterable and adding the results together. |
| public long | sumOfInt(IntFunction<? super V> function)
Implements org. Returns the final long result of evaluating function for each element of the iterable and adding the results together. |
| public long | sumOfLong(LongFunction<? super V> function)
Implements org. Returns the final long result of evaluating function for each element of the iterable and adding the results together. |
| public Object[] | toArray()
Overrides default org. Converts this iterable to an array. |
| public <T> T[] | toArray(T[] a)
Overrides default org. Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable. |
| public MutableBag | toBag()
Implements org. Converts the collection to the default MutableBag implementation. |
| public <NK, NV> MutableBiMap | toBiMap(Function<? super V, ? extends NK> keyFunction, Function<? super V, ? extends NV> valueFunction)
Implements org. Converts the collection to a BiMap implementation using the specified key and value functions. |
| public MutableList | toList()
Implements org. Converts the collection to a MutableList implementation. |
| public <NK, NV> MutableMap | toMap(Function<? super V, ? extends NK> keyFunction, Function<? super V, ? extends NV> valueFunction)
Implements org. Converts the collection to a MutableMap implementation using the specified key and value functions. |
| public <NK, NV, R extends Map | toMap(Function<? super V, ? extends NK> keyFunction, Function<? super V, ? extends NV> valueFunction, R target)
Overrides default org. Same as |
| public MutableSet | toSet()
Implements org. Converts the collection to a MutableSet implementation. |
| public MutableSortedBag | toSortedBag()
Implements org. Converts the collection to a MutableSortedBag implementation and sorts it using the natural order of the elements. |
| public MutableSortedBag | toSortedBag(Comparator<? super V> comparator)
Implements org. Converts the collection to the MutableSortedBag implementation and sorts it using the specified comparator. |
| public MutableList | toSortedList()
Overrides default org. Converts the collection to a MutableList implementation and sorts it using the natural order of the elements. |
| public MutableList | toSortedList(Comparator<? super V> comparator)
Overrides default org. Converts the collection to a MutableList implementation and sorts it using the specified comparator. |
| public <NK, NV> MutableSortedMap | toSortedMap(Function<? super V, ? extends NK> keyFunction, Function<? super V, ? extends NV> valueFunction)
Implements org. Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the key elements' natural ordering. |
| public <NK, NV> MutableSortedMap | toSortedMap(Comparator<? super NK> comparator, Function<? super V, ? extends NK> keyFunction, Function<? super V, ? extends NV> valueFunction)
Implements org. Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the given comparator. |
| public MutableSortedSet | toSortedSet()
Implements org. Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the elements. |
| public MutableSortedSet | toSortedSet(Comparator<? super V> comparator)
Implements org. Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator. |
| public String | toString()
Overrides java. Implements org. Returns a string with the keys and values of this map separated by commas with spaces and enclosed in curly braces. |
| public RichIterable | valuesView()
Implements org. Returns an unmodifiable lazy iterable wrapped around the values for the map. |
| public <S, R extends Collection | zip(Iterable<S> that, R target)
Implements org.
Deprecated
in 8.0.
Same as |
| public <R extends Collection | zipWithIndex(R target)
Implements org.
Deprecated
in 8.0.
Same as |