Package org.hibernate.search.engine.search.predicate.dsl

Interface MatchIdPredicateMatchingStep<N extends MatchIdPredicateMatchingMoreStep<?,?>>

Type Parameters:

N - The type of the next step.

All Known Subinterfaces:

MatchIdPredicateMatchingMoreStep<S,N>

public interface MatchIdPredicateMatchingStep<N extends MatchIdPredicateMatchingMoreStep<?,?>>

The step in a "match id" predicate definition where the IDs to match can be set.

Method Summary

Modifier and Type	Method	Description
default N	matching(Object value)	Target the identifier with the given id.
N	matching(Object value, ValueConvert convert)	Target the identifier with the given id.
default N	matchingAny(Collection<?> values)	Target the identifiers matching any of the values in a collection.
default N	matchingAny(Collection<?> values, ValueConvert convert)	Target the identifiers matching any of the values in a collection.

Method Detail

matching

default N matching(Object value)

Target the identifier with the given id.

If used multiple times, it will target any of the specified values.

Parameters:

value - the value of the id we want to match.

Returns:

The next step.

See Also:

matchingAny(Collection)

matching

N matching(Object value,
           ValueConvert convert)

Target the identifier with the given id.

If used multiple times, it will target any of the specified values.

Parameters:

value - the value of the id we want to match.

convert - Controls how the value should be converted before Hibernate Search attempts to interpret it as an identifier value. See ValueConvert for more information.

Returns:

The next step.

See Also:

matchingAny(Collection)

matchingAny

default N matchingAny(Collection<?> values)

Target the identifiers matching any of the values in a collection.

Parameters:

values - the collection of identifiers to match.

Returns:

The next step.

matchingAny

default N matchingAny(Collection<?> values,
                      ValueConvert convert)

Target the identifiers matching any of the values in a collection.

Parameters:

values - the collection of identifiers to match.

convert - Controls how the value should be converted before Hibernate Search attempts to interpret it as an identifier value. See ValueConvert for more information.

Returns:

The next step.