Package-level declarations

A Multimap that can hold duplicate key-value pairs and that maintains the insertion ordering of values for a given key.

A collection that holds pairs of objects (keys and values), however each key may be associated with multiple values.

A generic unordered collection that supports order-independent equality, like Set, but may have duplicate elements. A multiset is also sometimes called a bag.

A Multimap that can hold duplicate key-value pairs and that maintains the insertion ordering of values for a given key.

A collection that holds pairs of objects (keys and values), however each key may be associated with multiple values. Map keys are unique; the map holds only one value for each key.

A generic unordered collection that supports order-independent equality, like Set, but may have duplicate elements. A multiset is also sometimes called a bag.

A Multimap that cannot hold duplicate key-value pairs and that maintains the insertion ordering of values for a given key.

A Multimap that cannot hold duplicate key-value pairs and that maintains the insertion ordering of values for a given key.

The backing collection type for multiset. Used by the Multiset builder inference methods.

Adds all elements in this to collection.

Adds all elements in iterator to this. The iterator will be left exhausted: its hasNext method will return false.

Calls next on this, either numberToAdvance times or until hasNext returns false, whichever comes first.

Returns true if every element in this satisfies the predicate. If this is empty, true is returned.

Returns true if every element returned by this satisfies the given predicate. If this is empty, true is returned.

Returns true if any element in this satisfies the predicate.

Returns true if one or more elements returned by this satisfy the given predicate.

Adapts an Iterator to the Enumeration interface.

Returns a string representation of this, with the format [e1, e2, ..., en] (that is, identical to Arrays.toString(Iterables.toArray(iterable))). Note that for most implementations of Collection, collection.toString() also gives the same result, but that behavior is not generally guaranteed.

Returns a string representation of this, with the format [e1, e2, ..., en]. The iterator will be left exhausted: its hasNext method will return false.

Builds a new immutable list-multimap with the given builderAction, using the builder inference api.

Builds a new immutable multimap with the given builderAction, using the builder inference api.

Builds a new immutable multiset with the given builderAction, using the builder inference api.

Builds a new mutable list-multimap with the given builderAction, using the builder inference api.

Builds a new mutable multimap with the given builderAction, using the builder inference api.

Builds a new multiset with the given builderAction, using the builder inference api.

Builds a new mutable set-multimap with the given builderAction, using the builder inference api.

Builds a new immutable set-multimap with the given builderAction, using the builder inference api.

Returns every possible list that can be formed by choosing one element from each of the given lists in order; the "n-ary Cartesian product" of the lists. For example:

Returns every possible list that can be formed by choosing one element from each of the given lists in order; the "n-ary [Cartesian

Returns a view of the specified CharSequence as a List<Character>, viewing this as a sequence of Unicode code units. The view does not support any modification operations, but reflects any changes to the underlying character sequence.

Returns a view of the specified string as an immutable list of Char values.

Combines multiple iterables into a single iterable. The returned iterable has an iterator that traverses the elements in this, followed by the elements of each iterable in iterables sequentially. The source iterators are not polled until necessary.

Combines two iterables into a single iterable. The returned iterable has an iterator that traverses the elements in this, followed by the elements in other. The source iterators are not polled until necessary.

Combines two iterators into a single iterator. The returned iterator iterates across the elements in this, followed by the elements in iterators sequentially. The source iterators are not polled until necessary.

Combines two iterators into a single iterator. The returned iterator iterates across the elements in this, followed by the elements in other. The source iterators are not polled until necessary.

Combines three iterables into a single iterable. The returned iterable has an iterator that traverses the elements in this, followed by the elements in a, followed by the elements in b. The source iterators are not polled until necessary.

Combines three iterators into a single iterator. The returned iterator iterates across the elements in this, followed by the elements in a, followed by the elements in b. The source iterators are not polled until necessary.

Combines four iterables into a single iterable. The returned iterable has an iterator that traverses the elements in this, followed by the elements in a, followed by the elements in b, followed by the elements in c. The source iterators are not polled until necessary.

Combines two iterators into a single iterator. The returned iterator iterates across the elements in this, followed by the elements in a, followed by the elements in b, followed by the elements in c. The source iterators are not polled until necessary.

Concats a varargs array of iterators without making a defensive copy of the array.

Returns a view of the supplied iterable that wraps each generated Iterator through Iterators.consumingIterator.

Returns a view of the supplied this that removes each element from the supplied this as it is returned.

Returns true if this contains element.

Returns an iterable whose iterators cycle indefinitely over the elements of this.

Returns an iterable whose iterators cycle indefinitely over the provided elements.

Returns an iterator that cycles indefinitely over the elements of this.

Returns an iterator that cycles indefinitely over the provided elements.

Determines whether two iterables contain equal elements in the same order. More specifically, this method returns true if this and other contain the same number of elements and every element of other is equal to the corresponding element of other.

Determines whether two iterators contain equal elements in the same order. More specifically, this method returns true if this and other contain the same number of elements and every element of this is equal to the corresponding element of other.

Returns an empty read-only ListMultimap.

Returns an empty read-only Multimap.

Returns an empty read-only Multiset.

Returns an empty read-only SetMultimap.

Returns a view of this containing all elements that are of the type T.

Returns the elements of this that satisfy a predicate. The returned collection is a live view of this; changes to one affect the other.

Returns a view of this containing all elements that satisfy the input predicate retainIfTrue.

Returns the first element in this that satisfies the given predicate; use this method only when such an element is known to exist. If it is possible that no element will match, use tryFind or find instead.

Returns the first element in this that satisfies the given predicate; use this method only when such an element is known to exist. The iterator will be left exhausted: its hasNext method will return false. If it is possible that no element will match, use Iterator.tryFind or Iterator.find instead.

Combines multiple iterables into a single iterable. The returned iterable has an iterator that traverses the elements in this sequentially. The source iterators are not polled until necessary.

Combines two iterators into a single iterator. The returned iterator iterates across the elements in this sequentially. The source iterators are not polled until necessary.

Returns an iterator containing the elements of array in order. The returned iterator is a view of the array; subsequent changes to the array will be reflected in the iterator.

Adapts an Enumeration to the Iterator interface.

Returns the number of elements in the specified iterable that equal the specified object. This implementation avoids a full iteration when the iterable is a Multiset or Set.

Returns the number of elements in the specified iterator that equal the specified object. The iterator will be left exhausted: its hasNext method will return false.

Returns the element at the specified position in an iterable.

Advances thisposition + 1` times, returning the element at the positionth position.

Returns the element at the specified position in an iterable or a default value otherwise.

Advances thisposition + 1` times, returning the element at the positionth position or a default value otherwise.

Returns the first element in this or defaultValue if the iterable is empty. The Iterators analog to this method is Iterators.getNext.

Returns the last element of this or defaultValue if the iterable is empty. If this is a List with RandomAccess support, then this operation is guaranteed to be O(1).

Advances this to the end, returning the last element or defaultValue if the iterator is empty and defaultValue is not null.

Returns the next element in this or defaultValue if the iterator is empty. The Iterables analog to this method is Iterables.getFirst.

Returns the index in this of the first element that satisfies the provided predicate, or -1 if the Iterable has no such elements.

Returns the index in this of the first element that satisfies the provided predicate, or -1 if the Iterator has no such elements.

Determines if the given iterable contains no elements.

Returns a view of this containing its first limitSize elements. If this contains fewer than limitSize elements, the returned view contains all of its elements. The returned iterable's iterator supports remove() if this's iterator does.

Returns a view containing the first limitSize elements of this. If this contains fewer than limitSize elements, the returned view contains all of its elements.

Returns a view containing the first limitSize elements of this. If this contains fewer than limitSize elements, the returned view contains all of its elements. The returned iterator supports remove() if iterator does.

Returns an empty read-only ListMultimap.

Returns a new read-only ListMultimap of given elements.

Returns an iterable over the merged contents of all given Iterables in this. Equivalent entries will not be de-duplicated.

Returns an iterator over the merged contents of all given this, traversing every element of the input iterators. Equivalent entries will not be de-duplicated.

Returns an unmodifiable view of the difference of two multisets. In the returned multiset, the count of each element is the result of the zero-truncated subtraction of its count in the second multiset from its count in the first multiset, with elements that would have a count of 0 not included. The iteration order of the returned multiset matches that of the element set of this, with repeated occurrences of the same element appearing consecutively.

Returns an empty read-only Multimap.

Returns a new read-only Multimap of given elements.

Returns an empty read-only Multiset.

Returns a new read-only Multiset of given elements.

Returns an empty new MutableListMultimap.

Returns a new MutableListMultimap with the given elements.

Returns an empty new Multimap.

Returns a new Multimap with the given elements.

Returns a new MutableMultimap with the given elements.

Returns an empty new MutableMultiset.

Returns a new MutableMultiset with the given elements.

Returns an empty new MutableMultimap.

Returns a new MutableMultimap with the given elements.

Returns a Collection of all the permutations of the specified Iterable using naturalOrder for establishing the lexicographical ordering.

Returns a Collection of all the permutations of the specified Iterable using the specified comparator for establishing the lexicographical ordering.

Returns a Collection of all the permutations of the specified Iterable using the specified selector for establishing the lexicographical ordering.

Divides an iterable into unmodifiable sublists of the given size, padding the final iterable with null values if necessary. For example, partitioning an iterable containing [a, b, c, d, e] with a partition size of 3 yields [[a, b, c], [d, e, null]] -- an outer iterable containing two inner lists of three elements each, all in the original order.

Divides an iterator into unmodifiable sublists of the given size, padding the final iterator with null values if necessary. For example, partitioning an iterator containing [a, b, c, d, e] with a partition size of 3 yields [[a, b, c], [d, e, null]] -- an outer iterator containing two inner lists of three elements each, all in the original order.

Divides an iterable into unmodifiable sublists of the given size (the final iterable may be smaller). For example, partitioning an iterable containing [a, b, c, d, e] with a partition size of 3 yields [[a, b, c], [d, e]] -- an outer iterable containing two inner lists of three and two elements, all in the original order.

Divides an iterator into unmodifiable sublists of the given size (the final list may be smaller). For example, partitioning an iterator containing [a, b, c, d, e] with a partition size of 3 yields [[a, b, c], [d, e]] -- an outer iterator containing two inner lists of three and two elements, all in the original order.

Returns consecutive sublists of a list, each of the same size (the final list may be smaller). For example, partitioning a list containing [a, b, c, d, e] with a partition size of 3 yields [[a, b, c], [d, e]] -- an outer list containing two inner lists of three and two elements, all in the original order.

Returns a PeekingIterator backed by the given iterator.

Returns a Collection of all the permutations of the specified Collection.

Returns an unmodifiable view of the sum of two multisets. In the returned multiset, the count of each element is the sum of its counts in the two backing multisets. The iteration order of the returned multiset matches that of the element set of this followed by the members of the element set of other that are not contained in other, with repeated occurrences of the same element appearing consecutively.

Removes, from an iterable, every element that belongs to the provided collection.

Traverses an iterator and removes every element that belongs to the provided collection. The iterator will be left exhausted: its hasNext method will return false.

Removes, from an iterable, every element that satisfies the provided predicate.

Removes every element that satisfies the provided predicate from the iterator. The iterator will be left exhausted: its hasNext method will return false.

Removes, from an iterable, every element that does not belong to the provided collection.

Traverses an iterator and removes every element that does not belong to the provided collection. The iterator will be left exhausted: its hasNext method will return false.

Returns an empty read-only SetMultimap.

Returns a new read-only SetMultimap of given elements.

Returns an iterator containing only this.

Returns a view of this that skips its first numberToSkip elements. If this contains fewer than numberToSkip elements, the returned iterable skips all of its elements.

Transforms a ListMultimap into its immutable guava equivalent

Transforms a Multimap into its immutable guava equivalent

Transforms a Multiset into its immutable guava equivalent

Transforms a MutableListMultimap into its guava equivalent

Transforms a MutableMultimap into its guava equivalent

Transforms a MutableMultiset into its guava equivalent

Transforms a MutableSetMultimap into its guava equivalent

Transforms a SetMultimap into its immutable guava equivalent

Wraps an immutable guava list multimap into a ListMultimap instance.

Wraps an immutable guava multimap into a Multimap instance.

Wraps an immutable guava multiset into a Multiset instance.

Wraps an immutable guava set multimap into a SetMultimap instance.

Wraps a guava list multimap into a MutableListMultimap instance.

Wraps a guava multimap into a MutableMultimap instance.

Wraps a guava multiset into a MutableMultiset instance.

Wraps a guava set multimap into a MutableSetMultimap instance.

Returns a new ListMultimap filled with all elements of this multimap.

Returns a new Multiset filled with all elements of this multimap.

Returns a new Multiset filled with all elements of this collection.

Returns a new MutableListMultimap filled with all elements of this multimap.

Returns a new MutableMultimap filled with all elements of this multimap.

Returns a new MutableMultiset filled with all elements of this collection.

Returns a new MutableSetMultimap filled with all elements of this multimap.

Returns a new SetMultimap filled with all elements of this multimap.

Copies an iterable's elements into an array.

Copies an iterator's elements into an array. The iterator will be left exhausted: its hasNext method will return false.

Returns a collection that applies function to each element of this. The returned collection is a live view of this; changes to the base collection affects the returned one.

Returns a view containing the result of applying function to each element of this.

Returns a list that applies function to each element of this. The returned list is a transformed view of this; changes to this will be reflected in the returned list and vice versa.