net.ashwork.functionality.predicate

Interface PredicateN

All Superinterfaces:

AbstractPredicateN<PredicateN>, And<PredicateN>, net.ashwork.functionality.partial.Arity, net.ashwork.functionality.FunctionN<java.lang.Boolean>, LogicalOperator<PredicateN>, Nand<PredicateN>, Nor<PredicateN>, Not, Or<PredicateN>, OrNot<PredicateN>, net.ashwork.functionality.partial.ResultChainable<java.lang.Boolean>, net.ashwork.functionality.partial.ResultChainableResult<java.lang.Boolean>, Sub<PredicateN>, net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN, Xnor<PredicateN>, Xor<PredicateN>

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 PredicateN
extends AbstractPredicateN<PredicateN>

Represents a predicate that accepts n arguments and produces a boolean-valued result. This is the predicate specialization for ToBooleanFunctionN. All boolean-producing predicates are derived from this n-arity specialization.

This is a functional interface whose functional method is AbstractPredicateN.testAllUnchecked(Object...).

Since:

1.0.0

See Also:

ToBooleanFunctionN

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PredicateN.Instance An instance of AbstractPredicateN which properly defines the arity and type of that particular predicate.

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

net.ashwork.functionality.FunctionN.FunctionSizeException

Method Summary

Modifier and Type	Method and Description
default PredicateN	and(PredicateN other) Intersects this object with another object to produce a combined result.
default PredicateN	nand(PredicateN other) Intersects this object with another object to produce the complement of a combined result.
default PredicateN	nor(PredicateN other) Unions this object with another object to produce the complement of a combined result.
default PredicateN	not() Gets the complement of this object.
default PredicateN	or(PredicateN other) Unions this object with another object to produce a combined result.
default PredicateN	orNot(PredicateN other) Subtracts the other object from this object to produce the complement of a combined result.
default PredicateN	sub(PredicateN other) Subtracts the other object from this object to produce a combined result.
default PredicateN	xnor(PredicateN other) Disjunctively unions this object with another object to produce the complement of a combined result.
default PredicateN	xor(PredicateN other) Disjunctively unions this object with another object to produce a combined result.

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

applyAllAsBooleanUnchecked, testAllUnchecked

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

applyAllUnchecked

Methods inherited from interface net.ashwork.functionality.FunctionN

andThen, andThenUnchecked, arity, checkSize, checkSize, sizedApplyAllUnchecked

Method Detail

not

default PredicateN 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<PredicateN>

Specified by:

not in interface LogicalOperator<PredicateN>

Specified by:

not in interface Nand<PredicateN>

Specified by:

not in interface Nor<PredicateN>

Specified by:

not in interface Not

Specified by:

not in interface OrNot<PredicateN>

Specified by:

not in interface Sub<PredicateN>

Specified by:

not in interface Xnor<PredicateN>

Specified by:

not in interface Xor<PredicateN>

Returns:

a complement of this object

and

default PredicateN and(PredicateN 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<PredicateN>

Specified by:

and in interface And<PredicateN>

Specified by:

and in interface LogicalOperator<PredicateN>

Specified by:

and in interface Nand<PredicateN>

Specified by:

and in interface Sub<PredicateN>

Specified by:

and in interface Xnor<PredicateN>

Specified by:

and in interface Xor<PredicateN>

Parameters:

other - the intersected object

Returns:

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

or

default PredicateN or(PredicateN 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<PredicateN>

Specified by:

or in interface LogicalOperator<PredicateN>

Specified by:

or in interface Nor<PredicateN>

Specified by:

or in interface Or<PredicateN>

Specified by:

or in interface OrNot<PredicateN>

Specified by:

or in interface Xnor<PredicateN>

Specified by:

or in interface Xor<PredicateN>

Parameters:

other - the unioned object

Returns:

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

xor

default PredicateN xor(PredicateN 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<PredicateN>

Specified by:

xor in interface LogicalOperator<PredicateN>

Specified by:

xor in interface Xnor<PredicateN>

Specified by:

xor in interface Xor<PredicateN>

Parameters:

other - the disjunctively unioned object

Returns:

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

sub

default PredicateN sub(PredicateN 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<PredicateN>

Specified by:

sub in interface LogicalOperator<PredicateN>

Specified by:

sub in interface Sub<PredicateN>

Specified by:

sub in interface Xnor<PredicateN>

Specified by:

sub in interface Xor<PredicateN>

Parameters:

other - the subtrahend object

Returns:

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

nand

default PredicateN nand(PredicateN 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<PredicateN>

Specified by:

nand in interface LogicalOperator<PredicateN>

Specified by:

nand in interface Nand<PredicateN>

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 PredicateN nor(PredicateN 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<PredicateN>

Specified by:

nor in interface LogicalOperator<PredicateN>

Specified by:

nor in interface Nor<PredicateN>

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 PredicateN xnor(PredicateN 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<PredicateN>

Specified by:

xnor in interface LogicalOperator<PredicateN>

Specified by:

xnor in interface Xnor<PredicateN>

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 PredicateN orNot(PredicateN 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<PredicateN>

Specified by:

orNot in interface LogicalOperator<PredicateN>

Specified by:

orNot in interface OrNot<PredicateN>

Parameters:

other - the subtrahend object

Returns:

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