net.ashwork.functionality.predicate

Interface Predicate0

All Superinterfaces:

AbstractPredicate0<Predicate0>, AbstractPredicateN<Predicate0>, And<Predicate0>, 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.ToBooleanFunction0>, LogicalOperator<Predicate0>, Nand<Predicate0>, Nor<Predicate0>, Not, Or<Predicate0>, OrNot<Predicate0>, net.ashwork.functionality.partial.ResultChainable<java.lang.Boolean>, net.ashwork.functionality.partial.ResultChainableResult<java.lang.Boolean>, Sub<Predicate0>, net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN, Xnor<Predicate0>, Xor<Predicate0>

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 Predicate0
extends AbstractPredicate0<Predicate0>

Represents a predicate that accepts no arguments and produces a boolean-valued result. This is the zero-arity specialization for Predicate0. This is the predicate specialization for ToBooleanFunction0.

This is a functional interface whose functional method is AbstractPredicate0.test().

Since:

1.0.0

See Also:

Predicate0, ToBooleanFunction0

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 Predicate0	and(Predicate0 other) Intersects this object with another object to produce a combined result.
static Predicate0	fromFunctionVariant(net.ashwork.functionality.primitive.booleans.ToBooleanFunction0 function) Creates an instance of this object from its ToBooleanFunction0 function variant.
default Predicate0	nand(Predicate0 other) Intersects this object with another object to produce the complement of a combined result.
default Predicate0	nor(Predicate0 other) Unions this object with another object to produce the complement of a combined result.
default Predicate0	not() Gets the complement of this object.
default Predicate0	or(Predicate0 other) Unions this object with another object to produce a combined result.
default Predicate0	orNot(Predicate0 other) Subtracts the other object from this object to produce the complement of a combined result.
default Predicate0	sub(Predicate0 other) Subtracts the other object from this object to produce a combined result.
default Predicate0	xnor(Predicate0 other) Disjunctively unions this object with another object to produce the complement of a combined result.
default Predicate0	xor(Predicate0 other) Disjunctively unions this object with another object to produce a combined result.

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

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 Predicate0 fromFunctionVariant(net.ashwork.functionality.primitive.booleans.ToBooleanFunction0 function)

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

Parameters:

function - the function variant of this object

Returns:

an instance of this object

See Also:

ToBooleanFunction0

not

default Predicate0 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 AbstractPredicate0<Predicate0>

Specified by:

not in interface AbstractPredicateN<Predicate0>

Specified by:

not in interface LogicalOperator<Predicate0>

Specified by:

not in interface Nand<Predicate0>

Specified by:

not in interface Nor<Predicate0>

Specified by:

not in interface Not

Specified by:

not in interface OrNot<Predicate0>

Specified by:

not in interface Sub<Predicate0>

Specified by:

not in interface Xnor<Predicate0>

Specified by:

not in interface Xor<Predicate0>

Returns:

a complement of this object

and

default Predicate0 and(Predicate0 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 AbstractPredicate0<Predicate0>

Specified by:

and in interface AbstractPredicateN<Predicate0>

Specified by:

and in interface And<Predicate0>

Specified by:

and in interface LogicalOperator<Predicate0>

Specified by:

and in interface Nand<Predicate0>

Specified by:

and in interface Sub<Predicate0>

Specified by:

and in interface Xnor<Predicate0>

Specified by:

and in interface Xor<Predicate0>

Parameters:

other - the intersected object

Returns:

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

or

default Predicate0 or(Predicate0 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 AbstractPredicate0<Predicate0>

Specified by:

or in interface AbstractPredicateN<Predicate0>

Specified by:

or in interface LogicalOperator<Predicate0>

Specified by:

or in interface Nor<Predicate0>

Specified by:

or in interface Or<Predicate0>

Specified by:

or in interface OrNot<Predicate0>

Specified by:

or in interface Xnor<Predicate0>

Specified by:

or in interface Xor<Predicate0>

Parameters:

other - the unioned object

Returns:

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

xor

default Predicate0 xor(Predicate0 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 AbstractPredicate0<Predicate0>

Specified by:

xor in interface AbstractPredicateN<Predicate0>

Specified by:

xor in interface LogicalOperator<Predicate0>

Specified by:

xor in interface Xnor<Predicate0>

Specified by:

xor in interface Xor<Predicate0>

Parameters:

other - the disjunctively unioned object

Returns:

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

sub

default Predicate0 sub(Predicate0 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 AbstractPredicate0<Predicate0>

Specified by:

sub in interface AbstractPredicateN<Predicate0>

Specified by:

sub in interface LogicalOperator<Predicate0>

Specified by:

sub in interface Sub<Predicate0>

Specified by:

sub in interface Xnor<Predicate0>

Specified by:

sub in interface Xor<Predicate0>

Parameters:

other - the subtrahend object

Returns:

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

nand

default Predicate0 nand(Predicate0 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 AbstractPredicate0<Predicate0>

Specified by:

nand in interface AbstractPredicateN<Predicate0>

Specified by:

nand in interface LogicalOperator<Predicate0>

Specified by:

nand in interface Nand<Predicate0>

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 Predicate0 nor(Predicate0 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 AbstractPredicate0<Predicate0>

Specified by:

nor in interface AbstractPredicateN<Predicate0>

Specified by:

nor in interface LogicalOperator<Predicate0>

Specified by:

nor in interface Nor<Predicate0>

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 Predicate0 xnor(Predicate0 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 AbstractPredicate0<Predicate0>

Specified by:

xnor in interface AbstractPredicateN<Predicate0>

Specified by:

xnor in interface LogicalOperator<Predicate0>

Specified by:

xnor in interface Xnor<Predicate0>

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 Predicate0 orNot(Predicate0 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 AbstractPredicate0<Predicate0>

Specified by:

orNot in interface AbstractPredicateN<Predicate0>

Specified by:

orNot in interface LogicalOperator<Predicate0>

Specified by:

orNot in interface OrNot<Predicate0>

Parameters:

other - the subtrahend object

Returns:

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