AbstractPredicate2 (predicating 1.0.0 API)

Type Parameters:

T1 - the type of the first argument to the predicate

T2 - the type of the second argument to the predicate

P - the type of this predicate

All Superinterfaces:

AbstractPredicateN, And, 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, Nand, Nor, Not, Or, OrNot, net.ashwork.functionality.partial.ResultChainable<java.lang.Boolean>, net.ashwork.functionality.partial.ResultChainableResult<java.lang.Boolean>, Sub, net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN, net.ashwork.functionality.partial.Variant<java.util.function.BiPredicate<T1,T2>>, Xnor, Xor

All Known Subinterfaces:

Predicate2<T1,T2>
```
@InheritOnly
public interface AbstractPredicate2<T1,T2,P extends AbstractPredicate2<T1,T2,P>>
extends AbstractPredicateN, net.ashwork.functionality.partial.Variant<java.util.function.BiPredicate<T1,T2>>, net.ashwork.functionality.partial.FunctionVariant<java.lang.Boolean,net.ashwork.functionality.primitive.booleans.ToBooleanFunction2<T1,T2>>
```
Represents a predicate that accepts two arguments and produces a boolean-valued result. This is the one-arity specialization for AbstractPredicateN. This is the predicate specialization for ToBooleanFunction2.

Since:

1.0.0

See Also:

AbstractPredicateN, ToBooleanFunction2

API Note:

This is an abstract predicate and should not be used directly. It should instead be called by one of its subtypes.

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

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default AbstractPredicate2<T1,T2,P>`	`and(P other)` Intersects this object with another object to produce a combined result.
`default <V> net.ashwork.functionality.Function2<T1,T2,V>`	`andThen(net.ashwork.functionality.Function1<? super java.lang.Boolean,? extends V> after)`
`default <V> net.ashwork.functionality.Function2<T1,T2,V>`	`andThenUnchecked(net.ashwork.functionality.Function1<? super java.lang.Boolean,? extends V> after)`
`default int`	`arity()`
`default AbstractPredicate2<T1,T2,P>`	`nand(P other)` Intersects this object with another object to produce the complement of a combined result.
`default AbstractPredicate2<T1,T2,P>`	`nor(P other)` Unions this object with another object to produce the complement of a combined result.
`default AbstractPredicate2<T1,T2,P>`	`not()` Gets the complement of this object.
`default AbstractPredicate2<T1,T2,P>`	`or(P other)` Unions this object with another object to produce a combined result.
`default AbstractPredicate2<T1,T2,P>`	`orNot(P other)` Subtracts the other object from this object to produce the complement of a combined result.
`default AbstractPredicate2<T1,T2,P>`	`sub(P other)` Subtracts the other object from this object to produce a combined result.
`boolean`	`test(T1 t1, T2 t2)` Evaluates this predicate on the given arguments.
`default boolean`	`testAllUnchecked(java.lang.Object... args)` Evaluates this predicate on the given arguments.
`default net.ashwork.functionality.primitive.booleans.ToBooleanFunction2<T1,T2>`	`toFunctionVariant()`
`default java.util.function.BiPredicate<T1,T2>`	`toVariant()`
`default AbstractPredicate2<T1,T2,P>`	`xnor(P other)` Disjunctively unions this object with another object to produce the complement of a combined result.
`default AbstractPredicate2<T1,T2,P>`	`xor(P other)` Disjunctively unions this object with another object to produce a combined result.

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
 - test
```
boolean test(T1 t1,
 T2 t2)
```
 Evaluates this predicate on the given arguments.
 
 Parameters:
 
 t1 - the first input argument
 
 t2 - the second input argument
 
 Returns:
 
 true if the input arguments match the predicate, otherwise false
 - testAllUnchecked
```
default boolean testAllUnchecked(java.lang.Object... args)
```
 Description copied from interface: AbstractPredicateN
 
 Evaluates this predicate on the given arguments. Makes no assumptions of the arguments passed in and whether a value will compute successfully.
 
 Specified by:
 
 testAllUnchecked in interface AbstractPredicateN>
 
 Parameters:
 
 args - the input arguments
 
 Returns:
 
 true if the input arguments match the predicate, otherwise false
 - arity
```
default int arity()
```
 Specified by:
 
 arity in interface net.ashwork.functionality.partial.Arity
 
 Specified by:
 
 arity in interface net.ashwork.functionality.FunctionN<java.lang.Boolean>
 - toFunctionVariant
```
default net.ashwork.functionality.primitive.booleans.ToBooleanFunction2<T1,T2> toFunctionVariant()
```
 Specified by:
 
 toFunctionVariant in interface net.ashwork.functionality.partial.FunctionVariant<java.lang.Boolean,net.ashwork.functionality.primitive.booleans.ToBooleanFunction2<T1,T2>>
 
 See Also:
 
 ToBooleanFunction2
 - toVariant
```
default java.util.function.BiPredicate<T1,T2> toVariant()
```
 Specified by:
 
 toVariant in interface net.ashwork.functionality.partial.Variant<java.util.function.BiPredicate<T1,T2>>
 
 See Also:
 
 BiPredicate
 - andThen
```
default <V> net.ashwork.functionality.Function2<T1,T2,V> andThen(net.ashwork.functionality.Function1<? super java.lang.Boolean,? extends V> after)
```
 Specified by:
 
 andThen in interface net.ashwork.functionality.FunctionN<java.lang.Boolean>
 
 Specified by:
 
 andThen in interface net.ashwork.functionality.partial.ResultChainable<java.lang.Boolean>
 
 Specified by:
 
 andThen in interface net.ashwork.functionality.partial.ResultChainableResult<java.lang.Boolean>
 - andThenUnchecked
```
default <V> net.ashwork.functionality.Function2<T1,T2,V> andThenUnchecked(net.ashwork.functionality.Function1<? super java.lang.Boolean,? extends V> after)
```
 Specified by:
 
 andThenUnchecked in interface net.ashwork.functionality.FunctionN<java.lang.Boolean>
 
 Specified by:
 
 andThenUnchecked in interface net.ashwork.functionality.partial.ResultChainable<java.lang.Boolean>
 
 Specified by:
 
 andThenUnchecked in interface net.ashwork.functionality.partial.ResultChainableResult<java.lang.Boolean>
 - not
```
default AbstractPredicate2<T1,T2,P> 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 AbstractPredicateN>
 
 Specified by:
 
 not in interface LogicalOperator>
 
 Specified by:
 
 not in interface Nand>
 
 Specified by:
 
 not in interface Nor>
 
 Specified by:
 
 not in interface Not
 
 Specified by:
 
 not in interface OrNot>
 
 Specified by:
 
 not in interface Sub>
 
 Specified by:
 
 not in interface Xnor>
 
 Specified by:
 
 not in interface Xor>
 
 Returns:
 
 a complement of this object
 - and
```
default AbstractPredicate2<T1,T2,P> and(P 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 AbstractPredicateN>
 
 Specified by:
 
 and in interface And>
 
 Specified by:
 
 and in interface LogicalOperator>
 
 Specified by:
 
 and in interface Nand>
 
 Specified by:
 
 and in interface Sub>
 
 Specified by:
 
 and in interface Xnor>
 
 Specified by:
 
 and in interface Xor>
 
 Parameters:
 
 other - the intersected object
 
 Returns:
 
 a combined object that represents the intersection of this object and the other object
 - or
```
default AbstractPredicate2<T1,T2,P> or(P 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 AbstractPredicateN>
 
 Specified by:
 
 or in interface LogicalOperator>
 
 Specified by:
 
 or in interface Nor>
 
 Specified by:
 
 or in interface Or>
 
 Specified by:
 
 or in interface OrNot>
 
 Specified by:
 
 or in interface Xnor>
 
 Specified by:
 
 or in interface Xor>
 
 Parameters:
 
 other - the unioned object
 
 Returns:
 
 a combined object that represents the union of this object and the other object
 - xor
```
default AbstractPredicate2<T1,T2,P> xor(P 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 AbstractPredicateN>
 
 Specified by:
 
 xor in interface LogicalOperator>
 
 Specified by:
 
 xor in interface Xnor>
 
 Specified by:
 
 xor in interface Xor>
 
 Parameters:
 
 other - the disjunctively unioned object
 
 Returns:
 
 a combined object that represents the symmetric difference of this object and the other object
 - sub
```
default AbstractPredicate2<T1,T2,P> sub(P 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 AbstractPredicateN>
 
 Specified by:
 
 sub in interface LogicalOperator>
 
 Specified by:
 
 sub in interface Sub>
 
 Specified by:
 
 sub in interface Xnor>
 
 Specified by:
 
 sub in interface Xor>
 
 Parameters:
 
 other - the subtrahend object
 
 Returns:
 
 a combined object that represents the other object being subtracted from this object
 - nand
```
default AbstractPredicate2<T1,T2,P> nand(P 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 AbstractPredicateN>
 
 Specified by:
 
 nand in interface LogicalOperator>
 
 Specified by:
 
 nand in interface Nand>
 
 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 AbstractPredicate2<T1,T2,P> nor(P 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 AbstractPredicateN>
 
 Specified by:
 
 nor in interface LogicalOperator>
 
 Specified by:
 
 nor in interface Nor>
 
 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 AbstractPredicate2<T1,T2,P> xnor(P 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 AbstractPredicateN>
 
 Specified by:
 
 xnor in interface LogicalOperator>
 
 Specified by:
 
 xnor in interface Xnor>
 
 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 AbstractPredicate2<T1,T2,P> orNot(P 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 AbstractPredicateN>
 
 Specified by:
 
 orNot in interface LogicalOperator>
 
 Specified by:
 
 orNot in interface OrNot>
 
 Parameters:
 
 other - the subtrahend object
 
 Returns:
 
 a combined object that represents the complement of the other object being subtracted from this object

Interface AbstractPredicate2<T1,T2,P extends AbstractPredicate2<T1,T2,P>>

Nested Class Summary

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

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

Method Summary

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

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

Methods inherited from interface net.ashwork.functionality.FunctionN

Method Detail

test

testAllUnchecked

arity

toFunctionVariant

toVariant

andThen

andThenUnchecked

not

and

or

xor

sub

nand

nor

xnor

orNot