net.ashwork.functionality.predicate.primitive.chars

Interface CharPredicate1

All Superinterfaces:

AbstractCharPredicate1<CharPredicate1>, AbstractPredicateN<CharPredicate1>, And<CharPredicate1>, net.ashwork.functionality.partial.Arity, net.ashwork.functionality.FunctionN<java.lang.Boolean>, net.ashwork.functionality.partial.FunctionVariant<java.lang.Boolean,net.ashwork.functionality.primitive.combined.CharToBooleanFunction1>, net.ashwork.functionality.partial.InputChainable<java.lang.Character>, net.ashwork.functionality.partial.InputChainableInput<java.lang.Character>, LogicalOperator<CharPredicate1>, Nand<CharPredicate1>, Nor<CharPredicate1>, Not, Or<CharPredicate1>, OrNot<CharPredicate1>, net.ashwork.functionality.partial.ResultChainable<java.lang.Boolean>, net.ashwork.functionality.partial.ResultChainableResult<java.lang.Boolean>, Sub<CharPredicate1>, net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN, net.ashwork.functionality.partial.UnboxedInput<AbstractPredicate1<java.lang.Character,?>>, Xnor<CharPredicate1>, Xor<CharPredicate1>

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 CharPredicate1
extends AbstractCharPredicate1<CharPredicate1>

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

This is a functional interface whose functional method is AbstractCharPredicate1.test(char).

Since:

1.0.0

See Also:

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

Methods inherited from interface net.ashwork.functionality.predicate.abstracts.primitive.chars.AbstractCharPredicate1

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 CharPredicate1 fromFunctionVariant(net.ashwork.functionality.primitive.combined.CharToBooleanFunction1 function)

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

Parameters:

function - the function variant of this object

Returns:

an instance of this object

See Also:

CharToBooleanFunction1

boxInput

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

Specified by:

boxInput in interface AbstractCharPredicate1<CharPredicate1>

Specified by:

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

See Also:

Predicate1

compose

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

Specified by:

compose in interface AbstractCharPredicate1<CharPredicate1>

Specified by:

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

Specified by:

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

See Also:

Predicate1

composeUnchecked

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

Specified by:

composeUnchecked in interface AbstractCharPredicate1<CharPredicate1>

Specified by:

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

Specified by:

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

See Also:

Predicate1

not

default CharPredicate1 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 AbstractCharPredicate1<CharPredicate1>

Specified by:

not in interface AbstractPredicateN<CharPredicate1>

Specified by:

not in interface LogicalOperator<CharPredicate1>

Specified by:

not in interface Nand<CharPredicate1>

Specified by:

not in interface Nor<CharPredicate1>

Specified by:

not in interface Not

Specified by:

not in interface OrNot<CharPredicate1>

Specified by:

not in interface Sub<CharPredicate1>

Specified by:

not in interface Xnor<CharPredicate1>

Specified by:

not in interface Xor<CharPredicate1>

Returns:

a complement of this object

and

default CharPredicate1 and(CharPredicate1 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 AbstractCharPredicate1<CharPredicate1>

Specified by:

and in interface AbstractPredicateN<CharPredicate1>

Specified by:

and in interface And<CharPredicate1>

Specified by:

and in interface LogicalOperator<CharPredicate1>

Specified by:

and in interface Nand<CharPredicate1>

Specified by:

and in interface Sub<CharPredicate1>

Specified by:

and in interface Xnor<CharPredicate1>

Specified by:

and in interface Xor<CharPredicate1>

Parameters:

other - the intersected object

Returns:

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

or

default CharPredicate1 or(CharPredicate1 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 AbstractCharPredicate1<CharPredicate1>

Specified by:

or in interface AbstractPredicateN<CharPredicate1>

Specified by:

or in interface LogicalOperator<CharPredicate1>

Specified by:

or in interface Nor<CharPredicate1>

Specified by:

or in interface Or<CharPredicate1>

Specified by:

or in interface OrNot<CharPredicate1>

Specified by:

or in interface Xnor<CharPredicate1>

Specified by:

or in interface Xor<CharPredicate1>

Parameters:

other - the unioned object

Returns:

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

xor

default CharPredicate1 xor(CharPredicate1 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 AbstractCharPredicate1<CharPredicate1>

Specified by:

xor in interface AbstractPredicateN<CharPredicate1>

Specified by:

xor in interface LogicalOperator<CharPredicate1>

Specified by:

xor in interface Xnor<CharPredicate1>

Specified by:

xor in interface Xor<CharPredicate1>

Parameters:

other - the disjunctively unioned object

Returns:

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

sub

default CharPredicate1 sub(CharPredicate1 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 AbstractCharPredicate1<CharPredicate1>

Specified by:

sub in interface AbstractPredicateN<CharPredicate1>

Specified by:

sub in interface LogicalOperator<CharPredicate1>

Specified by:

sub in interface Sub<CharPredicate1>

Specified by:

sub in interface Xnor<CharPredicate1>

Specified by:

sub in interface Xor<CharPredicate1>

Parameters:

other - the subtrahend object

Returns:

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

nand

default CharPredicate1 nand(CharPredicate1 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 AbstractCharPredicate1<CharPredicate1>

Specified by:

nand in interface AbstractPredicateN<CharPredicate1>

Specified by:

nand in interface LogicalOperator<CharPredicate1>

Specified by:

nand in interface Nand<CharPredicate1>

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 CharPredicate1 nor(CharPredicate1 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 AbstractCharPredicate1<CharPredicate1>

Specified by:

nor in interface AbstractPredicateN<CharPredicate1>

Specified by:

nor in interface LogicalOperator<CharPredicate1>

Specified by:

nor in interface Nor<CharPredicate1>

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 CharPredicate1 xnor(CharPredicate1 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 AbstractCharPredicate1<CharPredicate1>

Specified by:

xnor in interface AbstractPredicateN<CharPredicate1>

Specified by:

xnor in interface LogicalOperator<CharPredicate1>

Specified by:

xnor in interface Xnor<CharPredicate1>

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 CharPredicate1 orNot(CharPredicate1 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 AbstractCharPredicate1<CharPredicate1>

Specified by:

orNot in interface AbstractPredicateN<CharPredicate1>

Specified by:

orNot in interface LogicalOperator<CharPredicate1>

Specified by:

orNot in interface OrNot<CharPredicate1>

Parameters:

other - the subtrahend object

Returns:

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