Uses of Interface
com.gs.collections.api.tuple.Pair

Packages that use Pair

Package	Description
com.gs.collections.api	This package contains interfaces for GS Collections API.
com.gs.collections.api.bag	This package contains interfaces for Bag API.
com.gs.collections.api.bag.sorted	This package contains interfaces for SortedBag API.
com.gs.collections.api.bimap	This package contains interfaces for BiMap API.
com.gs.collections.api.collection	This package contains FixedSizeCollection, ImmutableCollection and MutableCollection API.
com.gs.collections.api.list	This package contains interfaces for list API which enhance the performance and functionality of List.
com.gs.collections.api.map	This package contains interfaces for map API which enhance the performance and functionality of Map
com.gs.collections.api.map.primitive	This package contains API for primitive to primitive maps, primitive to object maps and object to primitive maps with mutable and immutable variants.
com.gs.collections.api.map.sorted	This package contains mutable and immutable sorted map interfaces.
com.gs.collections.api.multimap	This package contains interfaces for Multimap.
com.gs.collections.api.ordered
com.gs.collections.api.set	This package contains interfaces for set API which enhance the performance and functionality of Set.
com.gs.collections.api.set.sorted	This package contains interfaces for sorted set API.
com.gs.collections.api.stack	This package contains interfaces for stack API.
com.gs.collections.api.tuple	This package contains the Pair and Twin interfaces.

Uses of Pair in com.gs.collections.api

Methods in com.gs.collections.api with type parameters of type Pair

Modifier and Type	Method and Description
<S,R extends java.util.Collection<Pair<T,S>>> R	RichIterable.zip(java.lang.Iterable<S> that, R target) Same as RichIterable.zip(Iterable) but uses target for output.
<R extends java.util.Collection<Pair<T,java.lang.Integer>>> R	RichIterable.zipWithIndex(R target) Same as RichIterable.zipWithIndex() but uses target for output.

Methods in com.gs.collections.api that return types with arguments of type Pair

Modifier and Type	Method and Description
<S> LazyIterable<Pair<T,S>>	LazyIterable.zip(java.lang.Iterable<S> that) Creates a deferred zip iterable.
<S> RichIterable<Pair<T,S>>	RichIterable.zip(java.lang.Iterable<S> that) Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs.
LazyIterable<Pair<T,java.lang.Integer>>	LazyIterable.zipWithIndex() Creates a deferred zipWithIndex iterable.
RichIterable<Pair<T,java.lang.Integer>>	RichIterable.zipWithIndex() Zips this RichIterable with its indices.

Uses of Pair in com.gs.collections.api.bag

Methods in com.gs.collections.api.bag that return types with arguments of type Pair

Modifier and Type	Method and Description
<S> ImmutableBag<Pair<T,S>>	ImmutableBag.zip(java.lang.Iterable<S> that)
<S> MutableBag<Pair<T,S>>	MutableBag.zip(java.lang.Iterable<S> that)
<S> UnsortedBag<Pair<T,S>>	UnsortedBag.zip(java.lang.Iterable<S> that)
SetIterable<Pair<T,java.lang.Integer>>	Bag.zipWithIndex()
ImmutableSet<Pair<T,java.lang.Integer>>	ImmutableBag.zipWithIndex()
MutableSet<Pair<T,java.lang.Integer>>	MutableBag.zipWithIndex()
UnsortedSetIterable<Pair<T,java.lang.Integer>>	UnsortedBag.zipWithIndex()

Uses of Pair in com.gs.collections.api.bag.sorted

Methods in com.gs.collections.api.bag.sorted that return types with arguments of type Pair

Modifier and Type	Method and Description
<S> ImmutableList<Pair<T,S>>	ImmutableSortedBag.zip(java.lang.Iterable<S> that)
<S> MutableList<Pair<T,S>>	MutableSortedBag.zip(java.lang.Iterable<S> that)
ImmutableSortedSet<Pair<T,java.lang.Integer>>	ImmutableSortedBag.zipWithIndex()
MutableSortedSet<Pair<T,java.lang.Integer>>	MutableSortedBag.zipWithIndex()
SortedSetIterable<Pair<T,java.lang.Integer>>	SortedBag.zipWithIndex()

Uses of Pair in com.gs.collections.api.bimap

Method parameters in com.gs.collections.api.bimap with type arguments of type Pair

Modifier and Type	Method and Description
<K2,V2> BiMap<K2,V2>	BiMap.collect(Function2<? super K,? super V,Pair<K2,V2>> function)
<K2,V2> ImmutableBiMap<K2,V2>	ImmutableBiMap.collect(Function2<? super K,? super V,Pair<K2,V2>> function)
<K2,V2> MutableBiMap<K2,V2>	MutableBiMap.collect(Function2<? super K,? super V,Pair<K2,V2>> function)

Uses of Pair in com.gs.collections.api.collection

Methods in com.gs.collections.api.collection that return types with arguments of type Pair

Modifier and Type	Method and Description
<S> ImmutableCollection<Pair<T,S>>	ImmutableCollection.zip(java.lang.Iterable<S> that)
<S> MutableCollection<Pair<T,S>>	MutableCollection.zip(java.lang.Iterable<S> that)
ImmutableCollection<Pair<T,java.lang.Integer>>	ImmutableCollection.zipWithIndex()
MutableCollection<Pair<T,java.lang.Integer>>	MutableCollection.zipWithIndex()

Uses of Pair in com.gs.collections.api.list

Methods in com.gs.collections.api.list that return types with arguments of type Pair

Modifier and Type	Method and Description
<S> ImmutableList<Pair<T,S>>	ImmutableList.zip(java.lang.Iterable<S> that)
<S> ListIterable<Pair<T,S>>	ListIterable.zip(java.lang.Iterable<S> that)
<S> MutableList<Pair<T,S>>	MutableList.zip(java.lang.Iterable<S> that)
ImmutableList<Pair<T,java.lang.Integer>>	ImmutableList.zipWithIndex()
ListIterable<Pair<T,java.lang.Integer>>	ListIterable.zipWithIndex()
MutableList<Pair<T,java.lang.Integer>>	MutableList.zipWithIndex()

Uses of Pair in com.gs.collections.api.map

Methods in com.gs.collections.api.map that return Pair

Modifier and Type	Method and Description
Pair<K,V>	MapIterable.detect(Predicate2<? super K,? super V> predicate) Return the first key and value of the map for which the predicate evaluates to true when they are given as arguments.

Methods in com.gs.collections.api.map that return types with arguments of type Pair

Modifier and Type	Method and Description
RichIterable<Pair<K,V>>	MapIterable.keyValuesView() Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map
<S> ImmutableCollection<Pair<V,S>>	ImmutableMap.zip(java.lang.Iterable<S> that)
<S> MutableCollection<Pair<V,S>>	MutableMap.zip(java.lang.Iterable<S> that)
ImmutableCollection<Pair<V,java.lang.Integer>>	ImmutableMap.zipWithIndex()
MutableCollection<Pair<V,java.lang.Integer>>	MutableMap.zipWithIndex()

Methods in com.gs.collections.api.map with parameters of type Pair

Modifier and Type	Method and Description
V	MutableMap.add(Pair<K,V> keyValuePair) This method allows mutable map the ability to add an element in the form of Pair.
ImmutableMap<K,V>	ImmutableMap.newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)
MutableMap<K,V>	MutableMap.withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs) Convenience var-args version of withAllKeyValues

Method parameters in com.gs.collections.api.map with type arguments of type Pair

Modifier and Type	Method and Description
<K2,V2> ImmutableMap<K2,V2>	ImmutableMap.collect(Function2<? super K,? super V,Pair<K2,V2>> function)
<K2,V2> MapIterable<K2,V2>	MapIterable.collect(Function2<? super K,? super V,Pair<K2,V2>> function) For each key and value of the map the function is evaluated.
<K2,V2> MutableMap<K2,V2>	MutableMap.collect(Function2<? super K,? super V,Pair<K2,V2>> function)
<K2,V2> UnsortedMapIterable<K2,V2>	UnsortedMapIterable.collect(Function2<? super K,? super V,Pair<K2,V2>> function)
ImmutableMap<K,V>	ImmutableMap.newWithAllKeyValues(java.lang.Iterable<? extends Pair<? extends K,? extends V>> keyValues)
MutableMap<K,V>	MutableMap.withAllKeyValues(java.lang.Iterable<? extends Pair<? extends K,? extends V>> keyValues) This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements.

Uses of Pair in com.gs.collections.api.map.primitive

Methods in com.gs.collections.api.map.primitive that return types with arguments of type Pair

Modifier and Type	Method and Description
<S> MutableCollection<Pair<V,S>>	MutablePrimitiveObjectMap.zip(java.lang.Iterable<S> that)
MutableCollection<Pair<V,java.lang.Integer>>	MutablePrimitiveObjectMap.zipWithIndex()

Uses of Pair in com.gs.collections.api.map.sorted

Methods in com.gs.collections.api.map.sorted that return types with arguments of type Pair

Modifier and Type	Method and Description
<S> ImmutableList<Pair<V,S>>	ImmutableSortedMap.zip(java.lang.Iterable<S> that)
<S> MutableList<Pair<V,S>>	MutableSortedMap.zip(java.lang.Iterable<S> that)
<S> ListIterable<Pair<V,S>>	SortedMapIterable.zip(java.lang.Iterable<S> that)
ImmutableList<Pair<V,java.lang.Integer>>	ImmutableSortedMap.zipWithIndex()
MutableList<Pair<V,java.lang.Integer>>	MutableSortedMap.zipWithIndex()
ListIterable<Pair<V,java.lang.Integer>>	SortedMapIterable.zipWithIndex()

Methods in com.gs.collections.api.map.sorted with parameters of type Pair

Modifier and Type	Method and Description
ImmutableSortedMap<K,V>	ImmutableSortedMap.newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)
MutableSortedMap<K,V>	MutableSortedMap.with(Pair<K,V>... pairs)

Method parameters in com.gs.collections.api.map.sorted with type arguments of type Pair

Modifier and Type	Method and Description
<K2,V2> ImmutableMap<K2,V2>	ImmutableSortedMap.collect(Function2<? super K,? super V,Pair<K2,V2>> function)
<K2,V2> MutableMap<K2,V2>	MutableSortedMap.collect(Function2<? super K,? super V,Pair<K2,V2>> function)
ImmutableSortedMap<K,V>	ImmutableSortedMap.newWithAllKeyValues(java.lang.Iterable<? extends Pair<? extends K,? extends V>> keyValues)

Uses of Pair in com.gs.collections.api.multimap

Methods in com.gs.collections.api.multimap that return types with arguments of type Pair

Modifier and Type	Method and Description
RichIterable<Pair<K,RichIterable<V>>>	Multimap.keyMultiValuePairsView() Returns a lazy view of the pair of a key and and a lazy view of the values mapped to that key.
RichIterable<Pair<K,V>>	Multimap.keyValuePairsView() Returns a lazy view of all of the key/value pairs.

Methods in com.gs.collections.api.multimap with parameters of type Pair

Modifier and Type	Method and Description
boolean	MutableMultimap.putAllPairs(Pair<K,V>... pairs)

Uses of Pair in com.gs.collections.api.ordered

Methods in com.gs.collections.api.ordered that return types with arguments of type Pair

Modifier and Type	Method and Description
<S> ReversibleIterable<Pair<T,S>>	ReversibleIterable.zip(java.lang.Iterable<S> that)
<S> ListIterable<Pair<T,S>>	SortedIterable.zip(java.lang.Iterable<S> that)
ReversibleIterable<Pair<T,java.lang.Integer>>	ReversibleIterable.zipWithIndex()
SortedIterable<Pair<T,java.lang.Integer>>	SortedIterable.zipWithIndex()

Uses of Pair in com.gs.collections.api.set

Methods in com.gs.collections.api.set that return types with arguments of type Pair

Modifier and Type	Method and Description
<B> LazyIterable<Pair<T,B>>	SetIterable.cartesianProduct(SetIterable<B> set) Returns the set whose members are all possible ordered pairs (a, b) where a is a member of this and b is a member of set.
<S> ImmutableSet<Pair<T,S>>	ImmutableSet.zip(java.lang.Iterable<S> that)
<S> MutableSet<Pair<T,S>>	MutableSet.zip(java.lang.Iterable<S> that)
<S> UnsortedSetIterable<Pair<T,S>>	UnsortedSetIterable.zip(java.lang.Iterable<S> that)
ImmutableSet<Pair<T,java.lang.Integer>>	ImmutableSet.zipWithIndex()
MutableSet<Pair<T,java.lang.Integer>>	MutableSet.zipWithIndex()
SetIterable<Pair<T,java.lang.Integer>>	SetIterable.zipWithIndex()
UnsortedSetIterable<Pair<T,java.lang.Integer>>	UnsortedSetIterable.zipWithIndex()

Uses of Pair in com.gs.collections.api.set.sorted

Methods in com.gs.collections.api.set.sorted that return types with arguments of type Pair

Modifier and Type	Method and Description
<S> ImmutableList<Pair<T,S>>	ImmutableSortedSet.zip(java.lang.Iterable<S> that)
<S> MutableList<Pair<T,S>>	MutableSortedSet.zip(java.lang.Iterable<S> that)
ImmutableSortedSet<Pair<T,java.lang.Integer>>	ImmutableSortedSet.zipWithIndex()
MutableSortedSet<Pair<T,java.lang.Integer>>	MutableSortedSet.zipWithIndex()
SortedSetIterable<Pair<T,java.lang.Integer>>	SortedSetIterable.zipWithIndex()

Uses of Pair in com.gs.collections.api.stack

Methods in com.gs.collections.api.stack that return types with arguments of type Pair

Modifier and Type	Method and Description
<S> ImmutableStack<Pair<T,S>>	ImmutableStack.zip(java.lang.Iterable<S> that)
<S> MutableStack<Pair<T,S>>	MutableStack.zip(java.lang.Iterable<S> that)
<S> StackIterable<Pair<T,S>>	StackIterable.zip(java.lang.Iterable<S> that)
ImmutableStack<Pair<T,java.lang.Integer>>	ImmutableStack.zipWithIndex()
MutableStack<Pair<T,java.lang.Integer>>	MutableStack.zipWithIndex()
StackIterable<Pair<T,java.lang.Integer>>	StackIterable.zipWithIndex()

Uses of Pair in com.gs.collections.api.tuple

Subinterfaces of Pair in com.gs.collections.api.tuple

Modifier and Type	Interface and Description
interface	Twin<T>