/*
* Copyright 2015-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.querydsl.binding;
import java.util.Collection;
import java.util.Optional;
import com.querydsl.core.types.Path;
import com.querydsl.core.types.Predicate;
MultiValueBinding
creates a Predicate
out of given Path
and collection value. Used for specific parameter treatment in QuerydslBindings
. Author: Oliver Gierke Since: 1.11
/**
* {@link MultiValueBinding} creates a {@link Predicate} out of given {@link Path} and collection value. Used for
* specific parameter treatment in {@link QuerydslBindings}.
*
* @author Oliver Gierke
* @since 1.11
*/
@FunctionalInterface
public interface MultiValueBinding<T extends Path<? extends S>, S> {
Returns the predicate to be applied to the given Path
for the given collection value, which will contain all values submitted for the path bind. If a single value was provided only the collection will consist of exactly one element. Params: - path –
Path
to the property. Will not be null. - value – the value that should be bound. Will not be null or empty.
Returns: can be null, in which case the binding will not be incorporated in the overall Predicate
.
/**
* Returns the predicate to be applied to the given {@link Path} for the given collection value, which will contain
* all values submitted for the path bind. If a single value was provided only the collection will consist of exactly
* one element.
*
* @param path {@link Path} to the property. Will not be {@literal null}.
* @param value the value that should be bound. Will not be {@literal null} or empty.
* @return can be {@literal null}, in which case the binding will not be incorporated in the overall
* {@link Predicate}.
*/
Optional<Predicate> bind(T path, Collection<? extends S> value);
}