net.ashwork.functionality.predicate

Interface Predicate2<T1,T2>

Type Parameters:

T1 - the type of the first argument to the predicate

T2 - the type of the second argument to the predicate

All Superinterfaces:

AbstractPredicate2<T1,T2,Predicate2<T1,T2>>, AbstractPredicateN<Predicate2<T1,T2>>, And<Predicate2<T1,T2>>, net.ashwork.functionality.partial.Arity, net.ashwork.functionality.FunctionN<java.lang.Boolean>, net.ashwork.functionality.partial.FunctionVariant<java.lang.Boolean,net.ashwork.functionality.primitive.booleans.ToBooleanFunction2<T1,T2>>, LogicalOperator<Predicate2<T1,T2>>, Nand<Predicate2<T1,T2>>, Nor<Predicate2<T1,T2>>, Not, Or<Predicate2<T1,T2>>, OrNot<Predicate2<T1,T2>>, net.ashwork.functionality.partial.ResultChainable<java.lang.Boolean>, net.ashwork.functionality.partial.ResultChainableResult<java.lang.Boolean>, Sub<Predicate2<T1,T2>>, net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN, net.ashwork.functionality.partial.Variant<java.util.function.BiPredicate<T1,T2>>, Xnor<Predicate2<T1,T2>>, Xor<Predicate2<T1,T2>>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Predicate2<T1,T2>
extends AbstractPredicate2<T1,T2,Predicate2<T1,T2>>

Represents a predicate that accepts two arguments and produces a boolean-valued result. This is the one-arity specialization for PredicateN. This is the predicate specialization for ToBooleanFunction2.

This is a functional interface whose functional method is AbstractPredicate2.test(Object, Object).

Since:

1.0.0

See Also:

PredicateN, ToBooleanFunction2

Nested Class Summary

Nested classes/interfaces inherited from interface net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN

net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN.Instance

Nested classes/interfaces inherited from interface net.ashwork.functionality.FunctionN

net.ashwork.functionality.FunctionN.FunctionSizeException

Method Summary

Modifier and Type	Method and Description
default Predicate2<T1,T2>	and(Predicate2<T1,T2> other) Intersects this object with another object to produce a combined result.
static <T1,T2> Predicate2<T1,T2>	fromFunctionVariant(net.ashwork.functionality.primitive.booleans.ToBooleanFunction2<T1,T2> function) Creates an instance of this object from its ToBooleanFunction2 function variant.
static <T1,T2> Predicate2<T1,T2>	fromVariant(java.util.function.BiPredicate<T1,T2> predicate) Creates an instance of this object from its BiPredicate variant.
default Predicate2<T1,T2>	nand(Predicate2<T1,T2> other) Intersects this object with another object to produce the complement of a combined result.
default Predicate2<T1,T2>	nor(Predicate2<T1,T2> other) Unions this object with another object to produce the complement of a combined result.
default Predicate2<T1,T2>	not() Gets the complement of this object.
default Predicate2<T1,T2>	or(Predicate2<T1,T2> other) Unions this object with another object to produce a combined result.
default Predicate2<T1,T2>	orNot(Predicate2<T1,T2> other) Subtracts the other object from this object to produce the complement of a combined result.
default Predicate2<T1,T2>	sub(Predicate2<T1,T2> other) Subtracts the other object from this object to produce a combined result.
default Predicate2<T1,T2>	xnor(Predicate2<T1,T2> other) Disjunctively unions this object with another object to produce the complement of a combined result.
default Predicate2<T1,T2>	xor(Predicate2<T1,T2> other) Disjunctively unions this object with another object to produce a combined result.

Methods inherited from interface net.ashwork.functionality.predicate.abstracts.AbstractPredicate2

andThen, andThenUnchecked, arity, test, testAllUnchecked, toFunctionVariant, toVariant

Methods inherited from interface net.ashwork.functionality.predicate.abstracts.AbstractPredicateN

applyAllAsBooleanUnchecked

Methods inherited from interface net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN

applyAllUnchecked

Methods inherited from interface net.ashwork.functionality.FunctionN

checkSize, checkSize, sizedApplyAllUnchecked

Method Detail

fromFunctionVariant

static <T1,T2> Predicate2<T1,T2> fromFunctionVariant(net.ashwork.functionality.primitive.booleans.ToBooleanFunction2<T1,T2> function)

Creates an instance of this object from its ToBooleanFunction2 function variant.

Type Parameters:

T1 - the type of the first argument to the predicate

T2 - the type of the second argument to the predicate

Parameters:

function - the function variant of this object

Returns:

an instance of this object

See Also:

ToBooleanFunction2

fromVariant

static <T1,T2> Predicate2<T1,T2> fromVariant(java.util.function.BiPredicate<T1,T2> predicate)

Creates an instance of this object from its BiPredicate variant.

Type Parameters:

T1 - the type of the first argument to the predicate

T2 - the type of the second argument to the predicate

Parameters:

predicate - the variant of this object

Returns:

an instance of this object

See Also:

BiPredicate

not

default Predicate2<T1,T2> not()

Description copied from interface: Not

Gets the complement of this object. This is the equivalent of calling ~A or a logical NOT.

Specified by:

not in interface AbstractPredicate2<T1,T2,Predicate2<T1,T2>>

Specified by:

not in interface AbstractPredicateN<Predicate2<T1,T2>>

Specified by:

not in interface LogicalOperator<Predicate2<T1,T2>>

Specified by:

not in interface Nand<Predicate2<T1,T2>>

Specified by:

not in interface Nor<Predicate2<T1,T2>>

Specified by:

not in interface Not

Specified by:

not in interface OrNot<Predicate2<T1,T2>>

Specified by:

not in interface Sub<Predicate2<T1,T2>>

Specified by:

not in interface Xnor<Predicate2<T1,T2>>

Specified by:

not in interface Xor<Predicate2<T1,T2>>

Returns:

a complement of this object

and

default Predicate2<T1,T2> and(Predicate2<T1,T2> other)

Description copied from interface: And

Intersects this object with another object to produce a combined result. This is the equivalent of calling A & B or a logical AND.

Specified by:

and in interface AbstractPredicate2<T1,T2,Predicate2<T1,T2>>

Specified by:

and in interface AbstractPredicateN<Predicate2<T1,T2>>

Specified by:

and in interface And<Predicate2<T1,T2>>

Specified by:

and in interface LogicalOperator<Predicate2<T1,T2>>

Specified by:

and in interface Nand<Predicate2<T1,T2>>

Specified by:

and in interface Sub<Predicate2<T1,T2>>

Specified by:

and in interface Xnor<Predicate2<T1,T2>>

Specified by:

and in interface Xor<Predicate2<T1,T2>>

Parameters:

other - the intersected object

Returns:

a combined object that represents the intersection of this object and the other object

or

default Predicate2<T1,T2> or(Predicate2<T1,T2> other)

Description copied from interface: Or

Unions this object with another object to produce a combined result. This is the equivalent of calling A | B or a logical OR.

Specified by:

or in interface AbstractPredicate2<T1,T2,Predicate2<T1,T2>>

Specified by:

or in interface AbstractPredicateN<Predicate2<T1,T2>>

Specified by:

or in interface LogicalOperator<Predicate2<T1,T2>>

Specified by:

or in interface Nor<Predicate2<T1,T2>>

Specified by:

or in interface Or<Predicate2<T1,T2>>

Specified by:

or in interface OrNot<Predicate2<T1,T2>>

Specified by:

or in interface Xnor<Predicate2<T1,T2>>

Specified by:

or in interface Xor<Predicate2<T1,T2>>

Parameters:

other - the unioned object

Returns:

a combined object that represents the union of this object and the other object

xor

default Predicate2<T1,T2> xor(Predicate2<T1,T2> other)

Description copied from interface: Xor

Disjunctively unions this object with another object to produce a combined result. This is the equivalent of calling A ^ B or a logical XOR.

Specified by:

xor in interface AbstractPredicate2<T1,T2,Predicate2<T1,T2>>

Specified by:

xor in interface AbstractPredicateN<Predicate2<T1,T2>>

Specified by:

xor in interface LogicalOperator<Predicate2<T1,T2>>

Specified by:

xor in interface Xnor<Predicate2<T1,T2>>

Specified by:

xor in interface Xor<Predicate2<T1,T2>>

Parameters:

other - the disjunctively unioned object

Returns:

a combined object that represents the symmetric difference of this object and the other object

sub

default Predicate2<T1,T2> sub(Predicate2<T1,T2> other)

Description copied from interface: Sub

Subtracts the other object from this object to produce a combined result. This is the equivalent of calling A - B or the relative complement.

Specified by:

sub in interface AbstractPredicate2<T1,T2,Predicate2<T1,T2>>

Specified by:

sub in interface AbstractPredicateN<Predicate2<T1,T2>>

Specified by:

sub in interface LogicalOperator<Predicate2<T1,T2>>

Specified by:

sub in interface Sub<Predicate2<T1,T2>>

Specified by:

sub in interface Xnor<Predicate2<T1,T2>>

Specified by:

sub in interface Xor<Predicate2<T1,T2>>

Parameters:

other - the subtrahend object

Returns:

a combined object that represents the other object being subtracted from this object

nand

default Predicate2<T1,T2> nand(Predicate2<T1,T2> other)

Description copied from interface: Nand

Intersects this object with another object to produce the complement of a combined result. This is the equivalent of calling ~(A & B) or a logical NAND.

Specified by:

nand in interface AbstractPredicate2<T1,T2,Predicate2<T1,T2>>

Specified by:

nand in interface AbstractPredicateN<Predicate2<T1,T2>>

Specified by:

nand in interface LogicalOperator<Predicate2<T1,T2>>

Specified by:

nand in interface Nand<Predicate2<T1,T2>>

Parameters:

other - the intersected object

Returns:

a combined object that represents the complement of the intersection of this object and the other object

nor

default Predicate2<T1,T2> nor(Predicate2<T1,T2> other)

Description copied from interface: Nor

Unions this object with another object to produce the complement of a combined result. This is the equivalent of calling ~(A | B) or a logical NOR.

Specified by:

nor in interface AbstractPredicate2<T1,T2,Predicate2<T1,T2>>

Specified by:

nor in interface AbstractPredicateN<Predicate2<T1,T2>>

Specified by:

nor in interface LogicalOperator<Predicate2<T1,T2>>

Specified by:

nor in interface Nor<Predicate2<T1,T2>>

Parameters:

other - the unioned object

Returns:

a combined object that represents the complement of the union of this object and the other object

xnor

default Predicate2<T1,T2> xnor(Predicate2<T1,T2> other)

Description copied from interface: Xnor

Disjunctively unions this object with another object to produce the complement of a combined result. This is the equivalent of calling ~(A ^ B) or a logical XNOR.

Specified by:

xnor in interface AbstractPredicate2<T1,T2,Predicate2<T1,T2>>

Specified by:

xnor in interface AbstractPredicateN<Predicate2<T1,T2>>

Specified by:

xnor in interface LogicalOperator<Predicate2<T1,T2>>

Specified by:

xnor in interface Xnor<Predicate2<T1,T2>>

Parameters:

other - the disjunctively unioned object

Returns:

a combined object that represents the complement of the symmetric difference of this object and the other object

orNot

default Predicate2<T1,T2> orNot(Predicate2<T1,T2> other)

Description copied from interface: OrNot

Subtracts the other object from this object to produce the complement of a combined result. This is the equivalent of calling ~(A - B) or the complement of the relative complement.

Specified by:

orNot in interface AbstractPredicate2<T1,T2,Predicate2<T1,T2>>

Specified by:

orNot in interface AbstractPredicateN<Predicate2<T1,T2>>

Specified by:

orNot in interface LogicalOperator<Predicate2<T1,T2>>

Specified by:

orNot in interface OrNot<Predicate2<T1,T2>>

Parameters:

other - the subtrahend object

Returns:

a combined object that represents the complement of the other object being subtracted from this object