Package org.apache.commons.lang3.tuple
Class MutablePair<L,R> 
java.lang.Object
org.apache.commons.lang3.tuple.Pair<L,R>
 
org.apache.commons.lang3.tuple.MutablePair<L,R> 
- Type Parameters:
- L- the left element type
- R- the right element type
- All Implemented Interfaces:
- Serializable,- Comparable<Pair<L,,- R>> - Map.Entry<L,- R> 
A mutable pair consisting of two 
Object elements.
 Not #ThreadSafe#
- Since:
- 3.0
- See Also:
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final MutablePair<?,?>[] An empty array.Left objectRight object
- 
Constructor SummaryConstructorsConstructorDescriptionCreate a new pair instance of two nulls.MutablePair(L left, R right) Create a new pair instance.
- 
Method SummaryModifier and TypeMethodDescriptionstatic <L,R> MutablePair<L, R>[] Returns the empty array singleton that can be assigned without compiler warning.getLeft()Gets the left element from this pair.getRight()Gets the right element from this pair.static <L,R> MutablePair<L, R> Creates a mutable pair from a map entry.static <L,R> MutablePair<L, R> of(L left, R right) Creates a mutable pair of two objects inferring the generic types.static <L,R> MutablePair<L, R> ofNonNull(L left, R right) Creates a mutable pair of two non-null objects inferring the generic types.voidSets the left element of the pair.voidSets the right element of the pair.Sets theMap.Entryvalue.
- 
Field Details- 
EMPTY_ARRAYAn empty array.Consider using emptyArray()to avoid generics warnings.- Since:
- 3.10.
 
- 
leftLeft object
- 
rightRight object
 
- 
- 
Constructor Details- 
MutablePairpublic MutablePair()Create a new pair instance of two nulls.
- 
MutablePairCreate a new pair instance.- Parameters:
- left- the left value, may be null
- right- the right value, may be null
 
 
- 
- 
Method Details- 
emptyArrayReturns the empty array singleton that can be assigned without compiler warning.- Type Parameters:
- L- the left element type
- R- the right element type
- Returns:
- the empty array singleton that can be assigned without compiler warning.
- Since:
- 3.10.
 
- 
ofCreates a mutable pair of two objects inferring the generic types.This factory allows the pair to be created using inference to obtain the generic types. - Type Parameters:
- L- the left element type
- R- the right element type
- Parameters:
- left- the left element, may be null
- right- the right element, may be null
- Returns:
- a pair formed from the two parameters, not null
 
- 
ofCreates a mutable pair from a map entry.This factory allows the pair to be created using inference to obtain the generic types. - Type Parameters:
- L- the left element type
- R- the right element type
- Parameters:
- pair- the existing map entry.
- Returns:
- a pair formed from the map entry
 
- 
ofNonNullCreates a mutable pair of two non-null objects inferring the generic types.This factory allows the pair to be created using inference to obtain the generic types. - Type Parameters:
- L- the left element type
- R- the right element type
- Parameters:
- left- the left element, may not be null
- right- the right element, may not be null
- Returns:
- a pair formed from the two parameters, not null
- Throws:
- NullPointerException- if any input is null
- Since:
- 3.13.0
 
- 
getLeftGets the left element from this pair.When treated as a key-value pair, this is the key. 
- 
getRightGets the right element from this pair.When treated as a key-value pair, this is the value. 
- 
setLeftSets the left element of the pair.- Parameters:
- left- the new value of the left element, may be null
 
- 
setRightSets the right element of the pair.- Parameters:
- right- the new value of the right element, may be null
 
- 
setValueSets theMap.Entryvalue. This sets the right element of the pair.- Parameters:
- value- the right value to set, not null
- Returns:
- the old value for the right element
 
 
-