# Uses of Class
org.apache.commons.lang3.tuple.Pair

Packages that use Pair
Package
Description
org.apache.commons.lang3.builder
Assists in creating consistent `equals(Object)`, `toString()`, `hashCode()`, and `compareTo(Object)` methods.
org.apache.commons.lang3.exception
Provides functionality for Exceptions.
org.apache.commons.lang3.tuple
Tuple classes, starting with a Pair class in version 3.0.

- ## Uses of Pair in org.apache.commons.lang3.builder

  Subclasses of Pair in org.apache.commons.lang3.builder
  Modifier and Type
  Class
  Description
  `class`
  `Diff<T>`
  A `Diff` contains the differences between two `Diffable` class fields.

- ## Uses of Pair in org.apache.commons.lang3.exception

  Methods in org.apache.commons.lang3.exception that return types with arguments of type Pair
  Modifier and Type
  Method
  Description
  `List<Pair<String,Object>>`
  ContextedException.`getContextEntries()`
  Retrieves the full list of label-value pairs defined in the contextual data.
  `List<Pair<String,Object>>`
  ContextedRuntimeException.`getContextEntries()`
  Retrieves the full list of label-value pairs defined in the contextual data.
  `List<Pair<String,Object>>`
  DefaultExceptionContext.`getContextEntries()`
  Retrieves the full list of label-value pairs defined in the contextual data.
  `List<Pair<String,Object>>`
  ExceptionContext.`getContextEntries()`
  Retrieves the full list of label-value pairs defined in the contextual data.

- ## Uses of Pair in org.apache.commons.lang3.tuple

  Subclasses of Pair in org.apache.commons.lang3.tuple
  Modifier and Type
  Class
  Description
  `class`
  `ImmutablePair<L,R>`
  An immutable pair consisting of two `Object` elements.
  `class`
  `MutablePair<L,R>`
  A mutable pair consisting of two `Object` elements.
  Fields in org.apache.commons.lang3.tuple declared as Pair
  Modifier and Type
  Field
  Description
  `static final Pair<?,?>[]`
  Pair.`EMPTY_ARRAY`
  An empty array.
  Methods in org.apache.commons.lang3.tuple that return Pair
  Modifier and Type
  Method
  Description
  `static <L, R> Pair<L,R>[]`
  Pair.`emptyArray()`
  Returns the empty array singleton that can be assigned without compiler warning.
  `static <L, R> Pair<L,R>`
  ImmutablePair.`left(L left)`
  Creates an immutable pair of two objects inferring the generic types.
  `static <L, R> Pair<L,R>`
  Pair.`of(Map.Entry<L,R> pair)`
  Creates an immutable pair from a map entry.
  `static <L, R> Pair<L,R>`
  Pair.`of(L left, R right)`
  Creates an immutable pair of two objects inferring the generic types.
  `static <L, R> Pair<L,R>`
  Pair.`ofNonNull(L left, R right)`
  Creates an immutable pair of two non-null objects inferring the generic types.
  `static <L, R> Pair<L,R>`
  ImmutablePair.`right(R right)`
  Creates an immutable pair of two objects inferring the generic types.
  Methods in org.apache.commons.lang3.tuple with parameters of type Pair
  Modifier and Type
  Method
  Description
  `int`
  Pair.`compareTo(Pair<L,R> other)`
  Compares the pair based on the left element followed by the right element.