Package org.aoju.bus.core.lang.tuple

Class ImmutablePair<L,R>

java.lang.Object

org.aoju.bus.core.lang.tuple.Pair<L,R>

org.aoju.bus.core.lang.tuple.ImmutablePair<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>

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:

Java 17+

Author:

Kimi Liu

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
final L	left	Left object
final R	right	Right object

Constructor Summary

Constructors

Constructor	Description
ImmutablePair(L left, R right)	Create a new pair instance.

Method Summary

Modifier and Type	Method	Description
L	getLeft()	从这一对中获取左元素
R	getRight()	从这一对中获取右元素
static <L, R> ImmutablePair<L,R>	nullPair()	Returns an immutable pair of nulls.
static <L, R> ImmutablePair<L,R>	of(L left, R right)	Obtains an immutable pair of two objects inferring the generic types.
R	setValue(R value)	Throws UnsupportedOperationException.

Methods inherited from class org.aoju.bus.core.lang.tuple.Pair

compareTo, equals, getKey, getValue, hashCode, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

left

public final L left

Left object

right

public final R right

Right object

Constructor Details

ImmutablePair

public ImmutablePair(L left,
 R right)

Create a new pair instance.

Parameters:

left - the left value, may be null

right - the right value, may be null

Method Details

nullPair

public static <L,
R> ImmutablePair<L,R> nullPair()

Returns an immutable pair of nulls.

Type Parameters:

L - the left element of this pair. Value is null.

R - the right element of this pair. Value is null.

Returns:

an immutable pair of nulls.

of

public static <L,
R> ImmutablePair<L,R> of(L left,
 R right)

Obtains an immutable 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

getLeft

public L getLeft()

Description copied from class: Pair

从这一对中获取左元素

Specified by:

getLeft in class Pair<L,R>

Returns:

左边的元素可能是空的

getRight

public R getRight()

Description copied from class: Pair

从这一对中获取右元素

Specified by:

getRight in class Pair<L,R>

Returns:

右边的元素可能是空的

setValue

public R setValue(R value)

Throws UnsupportedOperationException.

This pair is immutable, so this operation is not supported.

Parameters:

value - the value to set

Returns:

never

Throws:

UnsupportedOperationException - as this operation is not supported