OpenJDK 1.23 · java.util.function.Predicate · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public default Predicate<T>	Returns: a composed predicate that represents the short-circuiting logical AND of this predicate and the `other` predicate and(Predicate<? super T> a predicate that will be logically-ANDed with this predicate other) Returns a composed predicate that represents a short-circuiting logical AND of this predicate and another.
public static < the type of arguments to the predicate T> Predicate<T>	Returns: a predicate that tests if two arguments are equal according to `Objects#equals(Object, Object)` isEqual(Object the object reference with which to compare for equality, which may be `null` targetRef) Returns a predicate that tests if two arguments are equal according to `Objects#equals(Object, Object)`.
public default Predicate<T>	Returns: a predicate that represents the logical negation of this predicate negate() Returns a predicate that represents the logical negation of this predicate.
public static < the type of arguments to the specified predicate T> Predicate<T>	Returns: a predicate that negates the results of the supplied predicate not(Predicate<? super T> predicate to negate target) Returns a predicate that is the negation of the supplied predicate.
public default Predicate<T>	Returns: a composed predicate that represents the short-circuiting logical OR of this predicate and the `other` predicate or(Predicate<? super T> a predicate that will be logically-ORed with this predicate other) Returns a composed predicate that represents a short-circuiting logical OR of this predicate and another.
public boolean	Returns: `true` if the input argument matches the predicate, otherwise `false` test(T the input argument t) Evaluates this predicate on the given argument.

Method Detail

and back to summary

and	back to summary
public default Predicate<T> and(Predicate<? super T> other) Returns a composed predicate that represents a short-circuiting logical AND of this predicate and another. When evaluating the composed predicate, if this predicate is `false`, then the `other` predicate is not evaluated. Any exceptions thrown during evaluation of either predicate are relayed to the caller; if evaluation of this predicate throws an exception, the `other` predicate will not be evaluated. Parameters other:Predicate<? super T> a predicate that will be logically-ANDed with this predicate Returns:Predicate<T> a composed predicate that represents the short-circuiting logical AND of this predicate and the `other` predicate Exceptions NullPointerException: if other is null

public default Predicate<T> and(Predicate<? super T> other)

Returns a composed predicate that represents a short-circuiting logical AND of this predicate and another. When evaluating the composed predicate, if this predicate is false, then the other predicate is not evaluated.

Any exceptions thrown during evaluation of either predicate are relayed to the caller; if evaluation of this predicate throws an exception, the other predicate will not be evaluated.

Parameters

other:Predicate<? super T>: a predicate that will be logically-ANDed with this predicate

Returns:Predicate<T>

a composed predicate that represents the short-circuiting logical AND of this predicate and the other predicate

Exceptions

NullPointerException:: if other is null

isEqual back to summary

isEqual	back to summary
public static <T> Predicate<T> isEqual(Object targetRef) Returns a predicate that tests if two arguments are equal according to `Objects#equals(Object, Object)`. Parameters <T> the type of arguments to the predicate targetRef:Object the object reference with which to compare for equality, which may be `null` Returns:Predicate<T> a predicate that tests if two arguments are equal according to `Objects#equals(Object, Object)`

public static <T> Predicate<T> isEqual(Object targetRef)

Returns a predicate that tests if two arguments are equal according to Objects#equals(Object, Object).

Parameters

<T>: the type of arguments to the predicate
targetRef:Object: the object reference with which to compare for equality, which may be null

Returns:Predicate<T>

a predicate that tests if two arguments are equal according to Objects#equals(Object, Object)

negate	back to summary
public default Predicate<T> negate() Returns a predicate that represents the logical negation of this predicate. Returns:Predicate<T> a predicate that represents the logical negation of this predicate

negate

back to summary

public default Predicate<T> negate()

Returns a predicate that represents the logical negation of this predicate.

Returns:Predicate<T>: a predicate that represents the logical negation of this predicate

not back to summary

not	back to summary
public static <T> Predicate<T> not(Predicate<? super T> target) Returns a predicate that is the negation of the supplied predicate. This is accomplished by returning result of the calling `target.negate()`. Parameters <T> the type of arguments to the specified predicate target:Predicate<? super T> predicate to negate Returns:Predicate<T> a predicate that negates the results of the supplied predicate Annotations @SuppressWarnings:unchecked Exceptions NullPointerException: if target is null Since 11

public static <T> Predicate<T> not(Predicate<? super T> target)

Returns a predicate that is the negation of the supplied predicate. This is accomplished by returning result of the calling target.negate().

Parameters

<T>: the type of arguments to the specified predicate
target:Predicate<? super T>: predicate to negate

Returns:Predicate<T>

a predicate that negates the results of the supplied predicate

Annotations

@SuppressWarnings:unchecked

Exceptions

NullPointerException:: if target is null

Since

or back to summary

or	back to summary
public default Predicate<T> or(Predicate<? super T> other) Returns a composed predicate that represents a short-circuiting logical OR of this predicate and another. When evaluating the composed predicate, if this predicate is `true`, then the `other` predicate is not evaluated. Any exceptions thrown during evaluation of either predicate are relayed to the caller; if evaluation of this predicate throws an exception, the `other` predicate will not be evaluated. Parameters other:Predicate<? super T> a predicate that will be logically-ORed with this predicate Returns:Predicate<T> a composed predicate that represents the short-circuiting logical OR of this predicate and the `other` predicate Exceptions NullPointerException: if other is null

public default Predicate<T> or(Predicate<? super T> other)

Returns a composed predicate that represents a short-circuiting logical OR of this predicate and another. When evaluating the composed predicate, if this predicate is true, then the other predicate is not evaluated.

Any exceptions thrown during evaluation of either predicate are relayed to the caller; if evaluation of this predicate throws an exception, the other predicate will not be evaluated.

Parameters

other:Predicate<? super T>: a predicate that will be logically-ORed with this predicate

Returns:Predicate<T>

a composed predicate that represents the short-circuiting logical OR of this predicate and the other predicate

Exceptions

NullPointerException:: if other is null

test back to summary

test	back to summary
public boolean test(T t) Evaluates this predicate on the given argument. Parameters t:T the input argument Returns:boolean `true` if the input argument matches the predicate, otherwise `false`

public boolean test(T t)

Evaluates this predicate on the given argument.

Parameters

t:T: the input argument

Returns:boolean

true if the input argument matches the predicate, otherwise false

public Interface Predicate<T>

Method Summary

Method Detail