de.caff.generics

Class BooleanPair

java.lang.Object

de.caff.generics.BooleanPair

All Implemented Interfaces:

BooleanIndexable, PrimitiveBooleanIterable, Sizeable, java.io.Serializable, java.lang.Iterable<java.lang.Boolean>

public final class BooleanPair
extends java.lang.Object
implements java.io.Serializable, BooleanIndexable

A pair of primitive boolean values.

This is similar to Pair, but for raw boolean values. As these values are defined final, this class is also immutable.

Because there are only 4 possible values of boolean pairs it is strongly recommended to use the factory method of(boolean, boolean) to create boolean pairs. This avoids unnecessary object creation.

Since:

December 04, 2020

Author:

Rammi

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface de.caff.generics.BooleanIndexable

BooleanIndexable.Base, BooleanIndexable.EntryConsumer

Field Summary

Fields

Modifier and Type	Field and Description
static BooleanPair	BOTH_FALSE Pair where both entries are false.
static BooleanPair	BOTH_TRUE Pair where both entries are true.
static BooleanPair	FALSE_TRUE Pair where the first entry is true and the second entry is false.
boolean	first The first value of this pair.
boolean	second The second value of this pair.
static BooleanPair	TRUE_FALSE Pair where the first entry is true and the second entry is false.

Fields inherited from interface de.caff.generics.BooleanIndexable

EMPTY, SINGLE_FALSE, SINGLE_TRUE

Fields inherited from interface de.caff.generics.PrimitiveBooleanIterable

EMPTY_BOOLEAN_ITERATOR

Fields inherited from interface de.caff.generics.Sizeable

NULL

Constructor Summary

Constructors

Constructor and Description
BooleanPair(boolean first, boolean second) Constructor.

Method Summary

Modifier and Type	Method and Description
<T> T	applyAsBooleans(BooleanFunction2<T> function) Apply a 2-boolean function on this pair.
boolean	equals(java.lang.Object o)
boolean	get(int index) Get the element at the given index.
int	hashCode()
static BooleanPair	of(boolean first, boolean second) Get one of the 4 predefined possibly values.
boolean	operate(BooleanOperator2 operator) Call an 2-boolean operator on this pair.
int	size() Get the size.
boolean	test(BooleanPredicate2 predicate) Call a 2-boolean predicate on this pair.
java.lang.String	toString()
Tuple2<java.lang.Boolean,java.lang.Boolean>	toTuple() Convert this into a tuple.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.caff.generics.BooleanIndexable

addAllTo, addToArray, addToArray, asBase, asCollection, asIndexable, asList, booleanIterator, booleanIterator, compare, emptyIndexable, equal, equal, firstMatch, foldLeft, forEachBoolEntry, frozen, getMod, gyt, hash, headSet, indexes, init, initByIndex, intIndexes, isEmpty, iterator, lastMatch, listIterator, nextMatch, previousMatch, reverse, rotated, singleton, subSet, sybSet, tailSet, toArray, toList, toString, view, viewArray, viewArray, viewArray, viewByIndex, viewIndexable, viewIndexable, viewIndexable, viewList, viewList, viewList, withAppendedValue, withCachedHash, withExchangedValueAt, withInsertedValueAt, withRemovedValueAt, withSwappedValuesAt

Methods inherited from interface de.caff.generics.PrimitiveBooleanIterable

and, containsBool, containsFalse, containsTrue, forEachBool, forEachBooleanFragile, forEachBoolFragile, or, xor

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

BOTH_FALSE

public static final BooleanPair BOTH_FALSE

Pair where both entries are false.

BOTH_TRUE

public static final BooleanPair BOTH_TRUE

Pair where both entries are true.

TRUE_FALSE

public static final BooleanPair TRUE_FALSE

Pair where the first entry is true and the second entry is false.

FALSE_TRUE

public static final BooleanPair FALSE_TRUE

Pair where the first entry is true and the second entry is false.

first

public final boolean first

The first value of this pair.

second

public final boolean second

The second value of this pair.

Constructor Detail

BooleanPair

public BooleanPair(boolean first,
                   boolean second)

Constructor.

Parameters:

first - first value of pair

second - second value of pair

Method Detail

size

public int size()

Description copied from interface: Sizeable

Get the size. Size is never negative.

Specified by:

size in interface Sizeable

Returns:

the size of this object, usually the number of contained elements, must not be negative

get

public boolean get(int index)

Description copied from interface: BooleanIndexable

Get the element at the given index.

Specified by:

get in interface BooleanIndexable

Parameters:

index - index between 0 and size() - 1

Returns:

element at the given index

applyAsBooleans

public <T> T applyAsBooleans(@NotNull
                             BooleanFunction2<T> function)

Apply a 2-boolean function on this pair.

Type Parameters:

T - output type

Parameters:

function - function to apply, first becomes its first, second its second argument

Returns:

result of applying the function

operate

public boolean operate(@NotNull
                       BooleanOperator2 operator)

Call an 2-boolean operator on this pair.

Parameters:

operator - operator to apply, first becomes its first, second its second argument

Returns:

result of applying the operator

test

public boolean test(@NotNull
                    BooleanPredicate2 predicate)

Call a 2-boolean predicate on this pair.

Parameters:

predicate - predicate to apply, first becomes its first, second its second argument

Returns:

result of testing this pair

toTuple

@NotNull
public Tuple2<java.lang.Boolean,java.lang.Boolean> toTuple()

Convert this into a tuple.

Returns:

tuple created from this pair

of

@NotNull
public static BooleanPair of(boolean first,
                                      boolean second)

Get one of the 4 predefined possibly values.

Parameters:

first - first value

second - second value

Returns:

boolean pair reflecting the given values

See Also:

BOTH_TRUE, BOTH_FALSE, TRUE_FALSE, FALSE_TRUE

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object