Modul de.sft.base

Package de.s42.base.functional

Klasse Pair<FirstType,SecondType>

java.lang.Object

de.s42.base.functional.Pair<FirstType,SecondType>

Typparameter:

FirstType -

SecondType -

public final class Pair<FirstType,SecondType>
extends Object

A pair of 2 values. Both types can be null. It provides handy access.

Autor:

Benjamin Schiller

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
private final FirstType	first	Stores the first final.
private final SecondType	second	Stores the second final.

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
private	Pair(FirstType first, SecondType second)	Constructs a pair of first and second.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	each(Consumer<FirstType> actionFirst, Consumer<SecondType> actionSecond)	Calls the action if first is not null with first as parameter.
static <FirstType, SecondType> Pair<FirstType,SecondType>	empty()	Create an empty Pair with both of the given values being null.
boolean	equals(Object obj)	Either is equal if first and second are equal.
Optional<FirstType>	first()	Returns the optional of first value
FirstType	firstOrElse(FirstType other)	Returns first if first is not null or other if first is null.
FirstType	firstOrThrow()	Returns a Optional of first or throws a exception if first is null.
int	hashCode()	The combined hashcode of first and second.
void	ifFirst(Consumer<FirstType> action)	Calls the action if first is not null with first as parameter.
void	ifSecond(Consumer<SecondType> action)	Calls the action if second is not null with second as parameter.
boolean	isFirst()	Returns true if first is not null.
boolean	isSecond()	Returns true if second is not null.
static <FirstType, SecondType> Pair<FirstType,SecondType>	of(FirstType first, SecondType second)	Create a Pair with both of the given values being non null.
static <FirstType, SecondType> Pair<FirstType,SecondType>	ofFirst(FirstType first)	Create a Pair with first set and second being null
static <FirstType, SecondType> Pair<FirstType,SecondType>	ofNullable(FirstType first, SecondType second)	Create a Pair with both of the given values being null or non null.
static <FirstType, SecondType> Pair<FirstType,SecondType>	ofSecond(SecondType second)	Create a Pair with second set and first being null
Optional<SecondType>	second()	Returns the optional of second value
SecondType	secondOrElse(SecondType other)	Returns second if second is not null or other if second is null.
SecondType	secondOrThrow()	Returns a Optional of second or throws a exception if second is null.
Stream<?>	stream()	Allows to get a stream to streaming first then second (only contains them if non null)
String	toString()	Returns a string in the form '[first, second]'

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

first

private final FirstType first

Stores the first final.

second

private final SecondType second

Stores the second final.

Konstruktordetails

Pair

private Pair(FirstType first,
 SecondType second)

Constructs a pair of first and second. Both values may be null

Parameter:

first - First value

second - Second value

Methodendetails

empty

public static <FirstType,
SecondType>
Pair<FirstType,SecondType> empty()

Create an empty Pair with both of the given values being null.

Typparameter:

FirstType - Type of the first value

SecondType - Type of the second value

Gibt zurück:

An empty Pair

of

public static <FirstType,
SecondType>
Pair<FirstType,SecondType> of(FirstType first,
 SecondType second)
                       throws NullPointerException

Create a Pair with both of the given values being non null.

Typparameter:

FirstType - Type of the first value

SecondType - Type of the second value

Parameter:

first - First value

second - Second value

Gibt zurück:

Pair of type <FirstType, SecondType>

Löst aus:

NullPointerException - if either of first or second is null

ofFirst

public static <FirstType,
SecondType>
Pair<FirstType,SecondType> ofFirst(FirstType first)
                            throws NullPointerException

Create a Pair with first set and second being null

Typparameter:

FirstType - Type of the first value

SecondType - Type of the second value

Parameter:

first - First value

Gibt zurück:

Pair of type <FirstType, SecondType>

Löst aus:

NullPointerException - if first is null

ofSecond

public static <FirstType,
SecondType>
Pair<FirstType,SecondType> ofSecond(SecondType second)
                             throws NullPointerException

Create a Pair with second set and first being null

Typparameter:

FirstType - Type of the first value

SecondType - Type of the second value

Parameter:

second - Second value

Gibt zurück:

Pair of type <FirstType, SecondType>

Löst aus:

NullPointerException - if second is null

ofNullable

public static <FirstType,
SecondType>
Pair<FirstType,SecondType> ofNullable(FirstType first,
 SecondType second)

Create a Pair with both of the given values being null or non null.

Typparameter:

FirstType - Type of the first value

SecondType - Type of the second value

Parameter:

first - First value

second - Second value

Gibt zurück:

Either of type <FirstType, SecondType>

each

public void each(Consumer<FirstType> actionFirst,
 Consumer<SecondType> actionSecond)

Calls the action if first is not null with first as parameter.

Parameter:

actionFirst - Called if first is not null

actionSecond - Called if second is not null

ifFirst

public void ifFirst(Consumer<FirstType> action)

Calls the action if first is not null with first as parameter.

Parameter:

action - Called if first is not null

ifSecond

public void ifSecond(Consumer<SecondType> action)

Calls the action if second is not null with second as parameter.

Parameter:

action - Called if second is not null

isFirst

public boolean isFirst()

Returns true if first is not null.

Gibt zurück:

True if first is not null

isSecond

public boolean isSecond()

Returns true if second is not null.

Gibt zurück:

True if second is not null

first

public Optional<FirstType> first()

Returns the optional of first value

Gibt zurück:

Optional of first value

firstOrThrow

public FirstType firstOrThrow()
                       throws NullPointerException

Returns a Optional of first or throws a exception if first is null.

Gibt zurück:

Optional of first or throws a exception if first is null

Löst aus:

NullPointerException - If first is null

firstOrElse

public FirstType firstOrElse(FirstType other)

Returns first if first is not null or other if first is null.

Parameter:

other - Value that will be returned if first is null

Gibt zurück:

first if first is not null or other if first is null

second

public Optional<SecondType> second()

Returns the optional of second value

Gibt zurück:

Optional of second value

secondOrThrow

public SecondType secondOrThrow()
                         throws NullPointerException

Returns a Optional of second or throws a exception if second is null.

Gibt zurück:

Optional of second or throws a exception if second is null

Löst aus:

NullPointerException - If second is null

secondOrElse

public SecondType secondOrElse(SecondType other)

Returns second if second is not null or other if second is null.

Parameter:

other - Value that will be returned if second is null

Gibt zurück:

Second if second is not null or other if second is null

stream

public Stream<?> stream()

Allows to get a stream to streaming first then second (only contains them if non null)

Gibt zurück:

A stream that streams first then second

toString

public String toString()

Returns a string in the form '[first, second]'

Setzt außer Kraft:

toString in Klasse Object

Gibt zurück:

String of first then second

hashCode

public int hashCode()

The combined hashcode of first and second.

Setzt außer Kraft:

hashCode in Klasse Object

Gibt zurück:

Combined hashcode of first and second

equals

public boolean equals(Object obj)

Either is equal if first and second are equal.

Setzt außer Kraft:

equals in Klasse Object

Parameter:

obj - Other Either

Gibt zurück:

True if first and second are equal