net.ashwork.functionality.predicate.primitive.booleans

Interface BooleanPredicate1

All Superinterfaces:

AbstractBooleanPredicate1<BooleanPredicate1>, AbstractPredicateN<BooleanPredicate1>, And<BooleanPredicate1>, net.ashwork.functionality.partial.Arity, net.ashwork.functionality.FunctionN<java.lang.Boolean>, net.ashwork.functionality.partial.FunctionVariant<java.lang.Boolean,net.ashwork.functionality.operator.primitive.booleans.BooleanOperator1>, net.ashwork.functionality.partial.InputChainable<java.lang.Boolean>, net.ashwork.functionality.partial.InputChainableInput<java.lang.Boolean>, LogicalOperator<BooleanPredicate1>, Nand<BooleanPredicate1>, Nor<BooleanPredicate1>, Not, Or<BooleanPredicate1>, OrNot<BooleanPredicate1>, net.ashwork.functionality.partial.ResultChainable<java.lang.Boolean>, net.ashwork.functionality.partial.ResultChainableResult<java.lang.Boolean>, Sub<BooleanPredicate1>, net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN, net.ashwork.functionality.partial.UnboxedInput<AbstractPredicate1<java.lang.Boolean,?>>, Xnor<BooleanPredicate1>, Xor<BooleanPredicate1>

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 BooleanPredicate1
extends AbstractBooleanPredicate1<BooleanPredicate1>

Represents a predicate that accepts a boolean-valued argument and produces a boolean-valued result. This is the one-arity specialization for PredicateN. This is the predicate specialization for BooleanOperator1. This is the boolean-consuming primitive specialization of Predicate1.

This is a functional interface whose functional method is AbstractBooleanPredicate1.test(boolean).

Since:

1.0.0

See Also:

PredicateN, BooleanOperator1, Predicate1

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 BooleanPredicate1	and(BooleanPredicate1 other) Intersects this object with another object to produce a combined result.
default Predicate1<java.lang.Boolean>	boxInput()
default <V> Predicate1<V>	compose(net.ashwork.functionality.Function1<? super V,? extends java.lang.Boolean> before)
default <V> Predicate1<V>	composeUnchecked(net.ashwork.functionality.Function1<? super V,? extends java.lang.Boolean> before)
static BooleanPredicate1	fromFunctionVariant(net.ashwork.functionality.operator.primitive.booleans.BooleanOperator1 function) Creates an instance of this object from its BooleanOperator1 function variant.
default BooleanPredicate1	nand(BooleanPredicate1 other) Intersects this object with another object to produce the complement of a combined result.
default BooleanPredicate1	nor(BooleanPredicate1 other) Unions this object with another object to produce the complement of a combined result.
default BooleanPredicate1	not() Gets the complement of this object.
default BooleanPredicate1	or(BooleanPredicate1 other) Unions this object with another object to produce a combined result.
default BooleanPredicate1	orNot(BooleanPredicate1 other) Subtracts the other object from this object to produce the complement of a combined result.
default BooleanPredicate1	sub(BooleanPredicate1 other) Subtracts the other object from this object to produce a combined result.
default BooleanPredicate1	xnor(BooleanPredicate1 other) Disjunctively unions this object with another object to produce the complement of a combined result.
default BooleanPredicate1	xor(BooleanPredicate1 other) Disjunctively unions this object with another object to produce a combined result.

Methods inherited from interface net.ashwork.functionality.predicate.abstracts.primitive.booleans.AbstractBooleanPredicate1

andThen, andThenUnchecked, arity, test, testAllUnchecked, toFunctionVariant

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 BooleanPredicate1 fromFunctionVariant(net.ashwork.functionality.operator.primitive.booleans.BooleanOperator1 function)

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

Parameters:

function - the function variant of this object

Returns:

an instance of this object

See Also:

BooleanOperator1

boxInput

default Predicate1<java.lang.Boolean> boxInput()

Specified by:

boxInput in interface AbstractBooleanPredicate1<BooleanPredicate1>

Specified by:

boxInput in interface net.ashwork.functionality.partial.UnboxedInput<AbstractPredicate1<java.lang.Boolean,?>>

See Also:

Predicate1

compose

default <V> Predicate1<V> compose(net.ashwork.functionality.Function1<? super V,? extends java.lang.Boolean> before)

Specified by:

compose in interface AbstractBooleanPredicate1<BooleanPredicate1>

Specified by:

compose in interface net.ashwork.functionality.partial.InputChainable<java.lang.Boolean>

Specified by:

compose in interface net.ashwork.functionality.partial.InputChainableInput<java.lang.Boolean>

See Also:

Predicate1

composeUnchecked

default <V> Predicate1<V> composeUnchecked(net.ashwork.functionality.Function1<? super V,? extends java.lang.Boolean> before)

Specified by:

composeUnchecked in interface AbstractBooleanPredicate1<BooleanPredicate1>

Specified by:

composeUnchecked in interface net.ashwork.functionality.partial.InputChainable<java.lang.Boolean>

Specified by:

composeUnchecked in interface net.ashwork.functionality.partial.InputChainableInput<java.lang.Boolean>

See Also:

Predicate1

not

default BooleanPredicate1 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 AbstractBooleanPredicate1<BooleanPredicate1>

Specified by:

not in interface AbstractPredicateN<BooleanPredicate1>

Specified by:

not in interface LogicalOperator<BooleanPredicate1>

Specified by:

not in interface Nand<BooleanPredicate1>

Specified by:

not in interface Nor<BooleanPredicate1>

Specified by:

not in interface Not

Specified by:

not in interface OrNot<BooleanPredicate1>

Specified by:

not in interface Sub<BooleanPredicate1>

Specified by:

not in interface Xnor<BooleanPredicate1>

Specified by:

not in interface Xor<BooleanPredicate1>

Returns:

a complement of this object

and

default BooleanPredicate1 and(BooleanPredicate1 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 AbstractBooleanPredicate1<BooleanPredicate1>

Specified by:

and in interface AbstractPredicateN<BooleanPredicate1>

Specified by:

and in interface And<BooleanPredicate1>

Specified by:

and in interface LogicalOperator<BooleanPredicate1>

Specified by:

and in interface Nand<BooleanPredicate1>

Specified by:

and in interface Sub<BooleanPredicate1>

Specified by:

and in interface Xnor<BooleanPredicate1>

Specified by:

and in interface Xor<BooleanPredicate1>

Parameters:

other - the intersected object

Returns:

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

or

default BooleanPredicate1 or(BooleanPredicate1 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 AbstractBooleanPredicate1<BooleanPredicate1>

Specified by:

or in interface AbstractPredicateN<BooleanPredicate1>

Specified by:

or in interface LogicalOperator<BooleanPredicate1>

Specified by:

or in interface Nor<BooleanPredicate1>

Specified by:

or in interface Or<BooleanPredicate1>

Specified by:

or in interface OrNot<BooleanPredicate1>

Specified by:

or in interface Xnor<BooleanPredicate1>

Specified by:

or in interface Xor<BooleanPredicate1>

Parameters:

other - the unioned object

Returns:

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

xor

default BooleanPredicate1 xor(BooleanPredicate1 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 AbstractBooleanPredicate1<BooleanPredicate1>

Specified by:

xor in interface AbstractPredicateN<BooleanPredicate1>

Specified by:

xor in interface LogicalOperator<BooleanPredicate1>

Specified by:

xor in interface Xnor<BooleanPredicate1>

Specified by:

xor in interface Xor<BooleanPredicate1>

Parameters:

other - the disjunctively unioned object

Returns:

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

sub

default BooleanPredicate1 sub(BooleanPredicate1 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 AbstractBooleanPredicate1<BooleanPredicate1>

Specified by:

sub in interface AbstractPredicateN<BooleanPredicate1>

Specified by:

sub in interface LogicalOperator<BooleanPredicate1>

Specified by:

sub in interface Sub<BooleanPredicate1>

Specified by:

sub in interface Xnor<BooleanPredicate1>

Specified by:

sub in interface Xor<BooleanPredicate1>

Parameters:

other - the subtrahend object

Returns:

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

nand

default BooleanPredicate1 nand(BooleanPredicate1 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 AbstractBooleanPredicate1<BooleanPredicate1>

Specified by:

nand in interface AbstractPredicateN<BooleanPredicate1>

Specified by:

nand in interface LogicalOperator<BooleanPredicate1>

Specified by:

nand in interface Nand<BooleanPredicate1>

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 BooleanPredicate1 nor(BooleanPredicate1 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 AbstractBooleanPredicate1<BooleanPredicate1>

Specified by:

nor in interface AbstractPredicateN<BooleanPredicate1>

Specified by:

nor in interface LogicalOperator<BooleanPredicate1>

Specified by:

nor in interface Nor<BooleanPredicate1>

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 BooleanPredicate1 xnor(BooleanPredicate1 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 AbstractBooleanPredicate1<BooleanPredicate1>

Specified by:

xnor in interface AbstractPredicateN<BooleanPredicate1>

Specified by:

xnor in interface LogicalOperator<BooleanPredicate1>

Specified by:

xnor in interface Xnor<BooleanPredicate1>

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 BooleanPredicate1 orNot(BooleanPredicate1 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 AbstractBooleanPredicate1<BooleanPredicate1>

Specified by:

orNot in interface AbstractPredicateN<BooleanPredicate1>

Specified by:

orNot in interface LogicalOperator<BooleanPredicate1>

Specified by:

orNot in interface OrNot<BooleanPredicate1>

Parameters:

other - the subtrahend object

Returns:

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