net.ashwork.functionality.predicate

Class PredicateN.Instance

java.lang.Object

net.ashwork.functionality.predicate.PredicateN.Instance

All Implemented Interfaces:

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

Enclosing interface:

PredicateN

public static class PredicateN.Instance
extends java.lang.Object
implements AbstractPredicateN<PredicateN.Instance>

An instance of AbstractPredicateN which properly defines the arity and type of that particular predicate.

See Also:

AbstractPredicateN

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

Constructor Summary

Constructors

Constructor and Description
Instance(int arity, Predicate1<java.lang.Object[]> predicate) Constructs an instance of the predicate.

Method Summary

Modifier and Type	Method and Description
PredicateN.Instance	and(PredicateN.Instance other) Intersects this object with another object to produce a combined result.
<V> net.ashwork.functionality.FunctionN.Instance<V>	andThen(net.ashwork.functionality.Function1<? super java.lang.Boolean,? extends V> after)
<V> net.ashwork.functionality.FunctionN.Instance<V>	andThenUnchecked(net.ashwork.functionality.Function1<? super java.lang.Boolean,? extends V> after)
int	arity()
PredicateN.Instance	nand(PredicateN.Instance other) Intersects this object with another object to produce the complement of a combined result.
PredicateN.Instance	nor(PredicateN.Instance other) Unions this object with another object to produce the complement of a combined result.
PredicateN.Instance	not() Gets the complement of this object.
PredicateN.Instance	or(PredicateN.Instance other) Unions this object with another object to produce a combined result.
PredicateN.Instance	orNot(PredicateN.Instance other) Subtracts the other object from this object to produce the complement of a combined result.
PredicateN.Instance	sub(PredicateN.Instance other) Subtracts the other object from this object to produce a combined result.
boolean	testAllUnchecked(java.lang.Object... args) Evaluates this predicate on the given arguments.
PredicateN.Instance	xnor(PredicateN.Instance other) Disjunctively unions this object with another object to produce the complement of a combined result.
PredicateN.Instance	xor(PredicateN.Instance other) Disjunctively unions this object with another object to produce a combined result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

Instance

public Instance(int arity,
                Predicate1<java.lang.Object[]> predicate)

Constructs an instance of the predicate.

Parameters:

arity - the number of arguments of the predicate

predicate - the predicate to be applied

Method Detail

arity

public int arity()

Specified by:

arity in interface net.ashwork.functionality.FunctionN<java.lang.Boolean>

Specified by:

arity in interface net.ashwork.functionality.partial.Arity

testAllUnchecked

public 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<PredicateN.Instance>

Parameters:

args - the input arguments

Returns:

true if the input arguments match the predicate, otherwise false

andThen

public <V> net.ashwork.functionality.FunctionN.Instance<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>

See Also:

FunctionN.Instance

andThenUnchecked

public <V> net.ashwork.functionality.FunctionN.Instance<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>

See Also:

FunctionN.Instance

not

public PredicateN.Instance 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.Instance>

Specified by:

not in interface LogicalOperator<PredicateN.Instance>

Specified by:

not in interface Nand<PredicateN.Instance>

Specified by:

not in interface Nor<PredicateN.Instance>

Specified by:

not in interface Not

Specified by:

not in interface OrNot<PredicateN.Instance>

Specified by:

not in interface Sub<PredicateN.Instance>

Specified by:

not in interface Xnor<PredicateN.Instance>

Specified by:

not in interface Xor<PredicateN.Instance>

Returns:

a complement of this object

and

public PredicateN.Instance and(PredicateN.Instance 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.Instance>

Specified by:

and in interface And<PredicateN.Instance>

Specified by:

and in interface LogicalOperator<PredicateN.Instance>

Specified by:

and in interface Nand<PredicateN.Instance>

Specified by:

and in interface Sub<PredicateN.Instance>

Specified by:

and in interface Xnor<PredicateN.Instance>

Specified by:

and in interface Xor<PredicateN.Instance>

Parameters:

other - the intersected object

Returns:

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

or

public PredicateN.Instance or(PredicateN.Instance 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.Instance>

Specified by:

or in interface LogicalOperator<PredicateN.Instance>

Specified by:

or in interface Nor<PredicateN.Instance>

Specified by:

or in interface Or<PredicateN.Instance>

Specified by:

or in interface OrNot<PredicateN.Instance>

Specified by:

or in interface Xnor<PredicateN.Instance>

Specified by:

or in interface Xor<PredicateN.Instance>

Parameters:

other - the unioned object

Returns:

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

xor

public PredicateN.Instance xor(PredicateN.Instance 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.Instance>

Specified by:

xor in interface LogicalOperator<PredicateN.Instance>

Specified by:

xor in interface Xnor<PredicateN.Instance>

Specified by:

xor in interface Xor<PredicateN.Instance>

Parameters:

other - the disjunctively unioned object

Returns:

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

sub

public PredicateN.Instance sub(PredicateN.Instance 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.Instance>

Specified by:

sub in interface LogicalOperator<PredicateN.Instance>

Specified by:

sub in interface Sub<PredicateN.Instance>

Specified by:

sub in interface Xnor<PredicateN.Instance>

Specified by:

sub in interface Xor<PredicateN.Instance>

Parameters:

other - the subtrahend object

Returns:

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

nand

public PredicateN.Instance nand(PredicateN.Instance 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.Instance>

Specified by:

nand in interface LogicalOperator<PredicateN.Instance>

Specified by:

nand in interface Nand<PredicateN.Instance>

Parameters:

other - the intersected object

Returns:

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

nor

public PredicateN.Instance nor(PredicateN.Instance 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.Instance>

Specified by:

nor in interface LogicalOperator<PredicateN.Instance>

Specified by:

nor in interface Nor<PredicateN.Instance>

Parameters:

other - the unioned object

Returns:

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

xnor

public PredicateN.Instance xnor(PredicateN.Instance 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.Instance>

Specified by:

xnor in interface LogicalOperator<PredicateN.Instance>

Specified by:

xnor in interface Xnor<PredicateN.Instance>

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

public PredicateN.Instance orNot(PredicateN.Instance 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.Instance>

Specified by:

orNot in interface LogicalOperator<PredicateN.Instance>

Specified by:

orNot in interface OrNot<PredicateN.Instance>

Parameters:

other - the subtrahend object

Returns:

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