Package org.apache.commons.lang3.tuple
Class ImmutablePair<L,R>
- java.lang.Object
-
- org.apache.commons.lang3.tuple.Pair<L,R>
-
- org.apache.commons.lang3.tuple.ImmutablePair<L,R>
-
- Type Parameters:
L
- the left element typeR
- the right element type
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<Pair<L,R>>
,java.util.Map.Entry<L,R>
public final class ImmutablePair<L,R> extends Pair<L,R>
An immutable pair consisting of two
Object
elements.Although the implementation is immutable, there is no restriction on the objects that may be stored. If mutable objects are stored in the pair, then the pair itself effectively becomes mutable. The class is also
final
, so a subclass can not add undesirable behaviour.#ThreadSafe# if both paired objects are thread-safe
- Since:
- Lang 3.0
- Version:
- $Id: ImmutablePair.java 1592817 2014-05-06 17:57:38Z britter $
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ImmutablePair(L left, R right)
Create a new pair instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description L
getLeft()
Gets the left element from this pair.R
getRight()
Gets the right element from this pair.static <L,R>
ImmutablePair<L,R>of(L left, R right)
Obtains an immutable pair of from two objects inferring the generic types.R
setValue(R value)
ThrowsUnsupportedOperationException
.
-
-
-
Method Detail
-
of
public static <L,R> ImmutablePair<L,R> of(L left, R right)
Obtains an immutable pair of from 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 typeR
- the right element type- Parameters:
left
- the left element, may be nullright
- the right element, may be null- Returns:
- a pair formed from the two parameters, not null
-
getLeft
public L getLeft()
Gets the left element from this pair.
When treated as a key-value pair, this is the key.
-
getRight
public R getRight()
Gets the right element from this pair.
When treated as a key-value pair, this is the value.
-
-