| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public boolean | add(T o)
Implements java. Ensures that this collection contains the specified element (optional operation). |
| public boolean | addAll(Collection<? extends T> collection)
Implements java. Adds all of the elements in the specified collection to this collection (optional operation). |
| public boolean | addAllIterable(Iterable<? extends T> iterable)
Implements org.
|
| public boolean | allSatisfy(Predicate<? super T> 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 T, ? 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 T> predicate)
Implements org. Returns true if the predicate evaluates to true for any element of the iterable. |
| public <P> boolean | anySatisfyWith(Predicate2<? super T, ? 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, 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 void | clear()
Implements java. Removes all of the elements from this collection (optional operation). |
| public <V> MutableCollection | collect(Function<? super T, ? extends V> function)
Implements org. Returns a new MutableCollection with the results of applying the specified function to each element of the source collection. |
| public <V, R extends Collection | collect(Function<? super T, ? extends V> function, R target)
Implements org. Same as |
| public <R extends MutableBooleanCollection> R | collectBoolean(BooleanFunction<? super T> booleanFunction, R target)
Overrides default org. Same as |
| public <R extends MutableByteCollection> R | collectByte(ByteFunction<? super T> byteFunction, R target)
Overrides default org. Same as |
| public <R extends MutableCharCollection> R | collectChar(CharFunction<? super T> charFunction, R target)
Overrides default org. Same as |
| public <R extends MutableDoubleCollection> R | collectDouble(DoubleFunction<? super T> doubleFunction, R target)
Overrides default org. Same as |
| public <R extends MutableFloatCollection> R | collectFloat(FloatFunction<? super T> floatFunction, R target)
Overrides default org. Same as |
| public <V> MutableCollection | collectIf(Predicate<? super T> predicate, Function<? super T, ? extends V> function)
Implements org. Returns a new MutableCollection with the results of applying the specified function to each element of the source collection, but only for elements that evaluate to true for the specified predicate. |
| public <V, R extends Collection | collectIf(Predicate<? super T> predicate, Function<? super T, ? extends V> 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 T> intFunction, R target)
Overrides default org. Same as |
| public <R extends MutableLongCollection> R | collectLong(LongFunction<? super T> longFunction, R target)
Overrides default org. Same as |
| public <R extends MutableShortCollection> R | collectShort(ShortFunction<? super T> shortFunction, R target)
Overrides default org. Same as |
| public <P, V> MutableCollection | collectWith(Function2<? super T, ? super P, ? extends V> function, P parameter)
Implements org. Same as |
| public <P, A, R extends Collection | collectWith(Function2<? super T, ? super P, ? extends A> function, P parameter, R targetCollection)
Implements org. Same as collectWith but with a targetCollection parameter to gather the results. |
| public boolean | contains(Object o)
Implements java. Returns |
| public boolean | containsAll(Collection<?> collection)
Implements java. Returns |
| 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 int | count(Predicate<? super T> predicate)
Implements org. Return the total number of elements that answer true to the specified predicate. |
| public <P> int | countWith(Predicate2<? super T, ? super P> predicate, P parameter)
Implements org. Returns the total number of elements that evaluate to true for the specified predicate. |
| public T | detect(Predicate<? super T> 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 T | detectIfNone(Predicate<? super T> predicate, Function0<? extends T> function)
Overrides default org. Returns the first element of the iterable for which the predicate evaluates to true. |
| public Optional | detectOptional(Predicate<? super T> predicate)
Implements org. Returns the first element of the iterable for which the predicate evaluates to true as an Optional. |
| public <P> T | detectWith(Predicate2<? super T, ? 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> T | detectWithIfNone(Predicate2<? super T, ? super P> predicate, P parameter, Function0<? extends T> 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 T, ? 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 T> procedure)
Implements org. The procedure is executed for each element in the iterable. |
| public <V> MutableCollection | flatCollect(Function<? super T, ? extends Iterable<V>> function)
Implements org.
|
| public <V, R extends Collection | flatCollect(Function<? super T, ? extends Iterable<V>> function, R target)
Implements org. Same as flatCollect, only the results are collected into the target collection. |
| public <P> void | forEachWith(Procedure2<? super T, ? 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 T> objectIntProcedure)
Implements org. Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure. |
| protected abstract Collection | |
| public T | getFirst()
Implements org. Returns the first element of an iterable. |
| public T | getLast()
Implements org. Returns the last element of an iterable. |
| public T | getOnly()
Overrides default org. Returns the element if the iterable has exactly one element. |
| public <V> MutableMultimap | groupBy(Function<? super T, ? extends V> function)
Implements org. For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable. |
| public <V, R extends MutableMultimap | groupBy(Function<? super T, ? extends V> function, R target)
Implements org. Same as |
| public <V> MutableMultimap | groupByEach(Function<? super T, ? extends Iterable<V>> function)
Implements org. Similar to |
| public <V, R extends MutableMultimap | groupByEach(Function<? super T, ? extends Iterable<V>> function, R target)
Implements org. Same as |
| public <V> MutableMap | groupByUniqueKey(Function<? super T, ? extends V> function)
Overrides default org. For each element of the iterable, the function is evaluated, and the results of these evaluations are collected into a new map, where the transformed value is the key. |
| public <V, R extends MutableMapIterable | groupByUniqueKey(Function<? super T, ? extends V> function, R target)
Implements org. Same as |
| public <IV> IV | injectInto(IV injectedValue, Function2<? super IV, ? super T, ? 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 T> 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 T> 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 double | injectInto(double injectedValue, DoubleObjectToDoubleFunction<? super T> 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 float | injectInto(float injectedValue, FloatObjectToFloatFunction<? super T> 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 <IV, P> IV | injectIntoWith(IV injectValue, Function3<? super IV, ? super T, ? super P, ? extends IV> function, P parameter)
Implements org. Returns the final result of evaluating function using each element of the iterable, the previous evaluation result and 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 java. Returns |
| public Iterator | iterator()
Implements java. Returns an iterator over the elements in this collection. |
| public T | max(Comparator<? super T> comparator)
Implements org. Returns the maximum element out of this container based on the comparator. |
| public T | max()
Implements org. Returns the maximum element out of this container based on the natural order. |
| public <V extends Comparable | maxBy(Function<? super T, ? extends V> function)
Implements org. Returns the maximum elements out of this container based on the natural order of the attribute returned by Function. |
| public T | min(Comparator<? super T> comparator)
Implements org. Returns the minimum element out of this container based on the comparator. |
| public T | min()
Implements org. Returns the minimum element out of this container based on the natural order. |
| public <V extends Comparable | minBy(Function<? super T, ? extends V> 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 T> 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 T, ? 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 PartitionMutableCollection | partition(Predicate<? super T> predicate)
Implements org. Filters a collection into a PartitionedIterable based on the evaluation of the predicate. |
| public <P> PartitionMutableCollection | partitionWith(Predicate2<? super T, ? super P> predicate, P parameter)
Implements org. Filters a collection into a PartitionIterable based on the evaluation of the predicate. |
| public MutableCollection | reject(Predicate<? super T> predicate)
Implements org. Returns a MutableCollection with all elements that evaluate to false for the specified predicate. |
| public <R extends Collection | reject(Predicate<? super T> predicate, R target)
Implements org. Same as the reject method with one parameter but uses the specified target collection for the results. |
| public <P> MutableCollection | rejectWith(Predicate2<? super T, ? super P> predicate, P parameter)
Implements org. Returns a MutableCollection with all elements that evaluate to false for the specified predicate2 and parameter. |
| public <P, R extends Collection | rejectWith(Predicate2<? super T, ? super P> predicate, P parameter, R targetCollection)
Implements org. Similar to |
| public boolean | remove(Object o)
Implements java. Removes a single instance of the specified element from this collection, if it is present (optional operation). |
| public boolean | removeAll(Collection<?> collection)
Implements java. Removes all of this collection's elements that are also contained in the specified collection (optional operation). |
| public boolean | removeAllIterable(Iterable<?> iterable)
Implements org.
|
| public boolean | removeIf(Predicate<? super T> predicate)
Implements org. Removes all elements in the collection that evaluate to true for the specified predicate. |
| public <P> boolean | removeIfWith(Predicate2<? super T, ? super P> predicate, P parameter)
Implements org. Removes all elements in the collection that evaluate to true for the specified predicate2 and parameter. |
| public boolean | retainAll(Collection<?> collection)
Implements java. Retains only the elements in this collection that are contained in the specified collection (optional operation). |
| public boolean | retainAllIterable(Iterable<?> iterable)
Implements org.
|
| public MutableCollection | select(Predicate<? super T> predicate)
Implements org. Returns a MutableCollection with all elements that evaluate to true for the specified predicate. |
| public <R extends Collection | select(Predicate<? super T> predicate, R target)
Implements org. Same as the select method with one parameter but uses the specified target collection for the results. |
| public <P> Twin | selectAndRejectWith(Predicate2<? super T, ? super P> predicate, P parameter)
Implements org. Filters a collection into two separate collections based on a predicate returned via a Pair. |
| public <S> MutableCollection | selectInstancesOf(Class<S> clazz)
Implements org. Returns all elements of the source collection that are instances of the Class |
| public <P> MutableCollection | selectWith(Predicate2<? super T, ? super P> predicate, P parameter)
Implements org. Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter. |
| public <P, R extends Collection | selectWith(Predicate2<? super T, ? super P> predicate, P parameter, R targetCollection)
Implements org. Similar to |
| public int | size()
Implements java. Returns the number of elements in this collection. |
| public <V> MutableObjectDoubleMap | sumByDouble(Function<? super T, ? extends V> groupBy, DoubleFunction<? super T> function)
Implements org. Groups and sums the values using the two specified functions. |
| public <V> MutableObjectDoubleMap | sumByFloat(Function<? super T, ? extends V> groupBy, FloatFunction<? super T> function)
Implements org. Groups and sums the values using the two specified functions. |
| public <V> MutableObjectLongMap | sumByInt(Function<? super T, ? extends V> groupBy, IntFunction<? super T> function)
Implements org. Groups and sums the values using the two specified functions. |
| public <V> MutableObjectLongMap | sumByLong(Function<? super T, ? extends V> groupBy, LongFunction<? super T> function)
Implements org. Groups and sums the values using the two specified functions. |
| public double | sumOfDouble(DoubleFunction<? super T> 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 T> 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 T> 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 T> function)
Implements org. Returns the final long result of evaluating function for each element of the iterable and adding the results together. |
| public MutableCollection | tap(Procedure<? super T> procedure)
Implements org. Executes the Procedure for each element in the iterable and returns |
| public Object[] | toArray()
Overrides default org. Returns an array containing all of the elements in this collection. |
| public <E> E[] | toArray(E[] a)
Overrides default org. Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. |
| public MutableBag | toBag()
Implements org. Converts the collection to the default MutableBag implementation. |
| public <K, V> MutableBiMap | toBiMap(Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> 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 <K, V> MutableMap | toMap(Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> valueFunction)
Implements org. Converts the collection to a MutableMap implementation using the specified key and value functions. |
| public <K, V, R extends Map | toMap(Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> 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 T> comparator)
Implements org. Converts the collection to the MutableSortedBag implementation and sorts it using the specified comparator. |
| public MutableList | toSortedList(Comparator<? super T> comparator)
Overrides default org. Converts the collection to a MutableList implementation and sorts it using the specified comparator. |
| public <K, V> MutableSortedMap | toSortedMap(Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> 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 <K, V> MutableSortedMap | toSortedMap(Comparator<? super K> comparator, Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> 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 T> 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 elements of this iterable separated by commas with spaces and enclosed in square brackets. |
| protected <E> MutableCollection | |
| public <S> MutableCollection | zip(Iterable<S> that)
Implements org. Returns a |
| public <S, R extends Collection | zip(Iterable<S> that, R target)
Implements org. Same as |
| public MutableCollection | zipWithIndex()
Implements org. Zips this |
| public <R extends Collection | zipWithIndex(R target)
Implements org. Same as |