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>

public class MutablePair<L,R>
extends Pair<L,R>

A mutable pair consisting of two Object elements.

Not #ThreadSafe#

Since:

Lang 3.0

Version:

$Id: MutablePair.java 1127544 2011-05-25 14:35:42Z scolebourne $

See Also:

Serialized Form

Field Summary

L	left Left object
R	right Right object

Constructor Summary

MutablePair()
Create a new pair instance of two nulls.

MutablePair(L left, R right)
Create a new pair instance.

Method Summary

L	getLeft() Gets the left element from this pair.
R	getRight() Gets the right element from this pair.
static <L,R> MutablePair<L,R>	of(L left, R right) Obtains an immutable pair of from two objects inferring the generic types.
void	setLeft(L left) Sets the left element of the pair.
void	setRight(R right) Sets the right element of the pair.
R	setValue(R value) Sets the Map.Entry value.

Methods inherited from class org.apache.commons.lang3.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 Detail

left

public L left

Left object

right

public R right

Right object

Constructor Detail

MutablePair

public MutablePair()

Create a new pair instance of two nulls.

MutablePair

public MutablePair(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 Detail

of

public static <L,R> MutablePair<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 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()

Gets the left element from this pair.

When treated as a key-value pair, this is the key.

Specified by:

getLeft in class Pair<L,R>

Returns:

the left element, may be null

setLeft

public void setLeft(L left)

Sets the left element of the pair.

Parameters:

left - the new value of the left element, may be null

getRight

public R getRight()

Gets the right element from this pair.

When treated as a key-value pair, this is the value.

Specified by:

getRight in class Pair<L,R>

Returns:

the right element, may be null

setRight

public void setRight(R right)

Sets the right element of the pair.

Parameters:

right - the new value of the right element, may be null

setValue

public R setValue(R value)

Sets the Map.Entry value. 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