com.landawn.abacus.util

Class Pair<L,R>

java.lang.Object

com.landawn.abacus.util.Pair<L,R>

Type Parameters:

L -

R -

public final class Pair<L,R>
extends Object

The Class Pair.

Since:

0.8

Author:

Haiyang Li

Field Summary

Fields

Modifier and Type	Field and Description
L	left The left.
R	right The right.

Constructor Summary

Constructors

Constructor and Description
Pair() Instantiates a new pair.

Method Summary

Modifier and Type	Method and Description
<E extends Exception> void	accept(Throwables.BiConsumer<? super L,? super R,E> action)
<E extends Exception> void	accept(Throwables.Consumer<? super Pair<L,R>,E> action)
Pair<L,R>	copy()
boolean	equals(Object obj)
<E extends Exception> u.Optional<Pair<L,R>>	filter(Throwables.BiPredicate<? super L,? super R,E> predicate)
<E extends Exception> u.Optional<Pair<L,R>>	filter(Throwables.Predicate<? super Pair<L,R>,E> predicate)
<E extends Exception> void	forEach(Throwables.Consumer<?,E> comsumer)
static <K,V> Pair<K,V>	from(Map.Entry<K,V> entry)
L	getAndSetLeft(L newLeft) Gets the and set left.
R	getAndSetRight(R newRight) Gets the and set right.
L	getLeft() Gets the left.
R	getRight() Gets the right.
int	hashCode()
<U,E extends Exception> U	map(Throwables.BiFunction<? super L,? super R,U,E> mapper)
<U,E extends Exception> U	map(Throwables.Function<? super Pair<L,R>,U,E> mapper)
static <L,R> Pair<L,R>	of(L l, R r)
Pair<R,L>	reverse() Returns a new instance of Pair<R, L>.
void	set(L left, R right)
L	setAndGetLeft(L newLeft) Sets the and get left.
R	setAndGetRight(R newRight) Sets the and get right.
<E extends Exception> boolean	setIf(L newLeft, R newRight, Throwables.TriPredicate<? super Pair<L,R>,? super L,? super R,E> predicate) Set to the specified newLeft and newRight and returns true if predicate returns true.
void	setLeft(L left) Sets the left.
<E extends Exception> boolean	setLeftIf(L newLeft, Throwables.BiPredicate<? super Pair<L,R>,? super L,E> predicate) Set to the specified newLeft and returns true if predicate returns true.
void	setRight(R right) Sets the right.
<E extends Exception> boolean	setRightIf(R newRight, Throwables.BiPredicate<? super Pair<L,R>,? super R,E> predicate) Set to the specified newRight and returns true if predicate returns true.
Stream<Pair<L,R>>	stream()
<T,E extends Exception> Stream<T>	stream(Throwables.Function<? super Pair<L,R>,Stream<T>,E> func)
Object[]	toArray()
<A> A[]	toArray(A[] a)
Map.Entry<L,R>	toEntry()
u.Optional<Pair<L,R>>	toOptional()
String	toString()
Tuple.Tuple2<L,R>	toTuple()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

left

public L left

The left.

right

public R right

The right.

Constructor Detail

Pair

public Pair()

Instantiates a new pair.

Method Detail

of

public static <L,R> Pair<L,R> of(L l,
                                 R r)

Type Parameters:

L -

R -

Parameters:

l -

r -

Returns:

from

public static <K,V> Pair<K,V> from(Map.Entry<K,V> entry)

Type Parameters:

K - the key type

V - the value type

Parameters:

entry -

Returns:

getLeft

public L getLeft()

Gets the left.

Returns:

setLeft

public void setLeft(L left)

Sets the left.

Parameters:

left - the new left

getRight

public R getRight()

Gets the right.

Returns:

setRight

public void setRight(R right)

Sets the right.

Parameters:

right - the new right

set

public void set(L left,
                R right)

Parameters:

left -

right -

getAndSetLeft

public L getAndSetLeft(L newLeft)

Gets the and set left.

Parameters:

newLeft -

Returns:

setAndGetLeft

public L setAndGetLeft(L newLeft)

Sets the and get left.

Parameters:

newLeft -

Returns:

getAndSetRight

public R getAndSetRight(R newRight)

Gets the and set right.

Parameters:

newRight -

Returns:

setAndGetRight

public R setAndGetRight(R newRight)

Sets the and get right.

Parameters:

newRight -

Returns:

setLeftIf

public <E extends Exception> boolean setLeftIf(L newLeft,
                                               Throwables.BiPredicate<? super Pair<L,R>,? super L,E> predicate)
                                        throws E extends Exception

Set to the specified newLeft and returns true if predicate returns true. Otherwise returns false without setting the value to new value.

Type Parameters:

E -

Parameters:

newLeft -

predicate - - the first parameter is current pair, the second parameter is the newLeft

Returns:

true, if successful

Throws:

E - the e

E extends Exception

setRightIf

public <E extends Exception> boolean setRightIf(R newRight,
                                                Throwables.BiPredicate<? super Pair<L,R>,? super R,E> predicate)
                                         throws E extends Exception

Set to the specified newRight and returns true if predicate returns true. Otherwise returns false without setting the value to new value.

Type Parameters:

E -

Parameters:

newRight -

predicate - - the first parameter is current pair, the second parameter is the newRight

Returns:

true, if successful

Throws:

E - the e

E extends Exception

setIf

public <E extends Exception> boolean setIf(L newLeft,
                                           R newRight,
                                           Throwables.TriPredicate<? super Pair<L,R>,? super L,? super R,E> predicate)
                                    throws E extends Exception

Set to the specified newLeft and newRight and returns true if predicate returns true. Otherwise returns false without setting the left/right to new values.

Type Parameters:

E -

Parameters:

newLeft -

newRight -

predicate - - the first parameter is current pair, the second parameter is the newLeft, the third parameter is the newRight.

Returns:

true, if successful

Throws:

E - the e

E extends Exception

reverse

@Beta
public Pair<R,L> reverse()

Returns a new instance of Pair<R, L>.

Returns:

a new instance of Pair<R, L>.

copy

public Pair<L,R> copy()

Returns:

toArray

public Object[] toArray()

Returns:

toArray

public <A> A[] toArray(A[] a)

Type Parameters:

A -

Parameters:

a -

Returns:

forEach

public <E extends Exception> void forEach(Throwables.Consumer<?,E> comsumer)
                                   throws E extends Exception

Type Parameters:

E -

Parameters:

comsumer -

Throws:

E - the e

E extends Exception

accept

public <E extends Exception> void accept(Throwables.BiConsumer<? super L,? super R,E> action)
                                  throws E extends Exception

Type Parameters:

E -

Parameters:

action -

Throws:

E - the e

E extends Exception

accept

public <E extends Exception> void accept(Throwables.Consumer<? super Pair<L,R>,E> action)
                                  throws E extends Exception

Type Parameters:

E -

Parameters:

action -

Throws:

E - the e

E extends Exception

map

public <U,E extends Exception> U map(Throwables.BiFunction<? super L,? super R,U,E> mapper)
                              throws E extends Exception

Type Parameters:

U -

E -

Parameters:

mapper -

Returns:

Throws:

E - the e

E extends Exception

map

public <U,E extends Exception> U map(Throwables.Function<? super Pair<L,R>,U,E> mapper)
                              throws E extends Exception

Type Parameters:

U -

E -

Parameters:

mapper -

Returns:

Throws:

E - the e

E extends Exception

filter

public <E extends Exception> u.Optional<Pair<L,R>> filter(Throwables.BiPredicate<? super L,? super R,E> predicate)
                                                   throws E extends Exception

Type Parameters:

E -

Parameters:

predicate -

Returns:

Throws:

E - the e

E extends Exception

filter

public <E extends Exception> u.Optional<Pair<L,R>> filter(Throwables.Predicate<? super Pair<L,R>,E> predicate)
                                                   throws E extends Exception

Type Parameters:

E -

Parameters:

predicate -

Returns:

Throws:

E - the e

E extends Exception

stream

public Stream<Pair<L,R>> stream()

Returns:

stream

public <T,E extends Exception> Stream<T> stream(Throwables.Function<? super Pair<L,R>,Stream<T>,E> func)
                                         throws E extends Exception

Throws:

E extends Exception

toOptional

public u.Optional<Pair<L,R>> toOptional()

toTuple

public Tuple.Tuple2<L,R> toTuple()

Returns:

toEntry

public Map.Entry<L,R> toEntry()

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true, if successful

toString

public String toString()

Overrides:

toString in class Object

Returns: