com.speedment.runtime.join.trait.HasWhere Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of runtime-deploy Show documentation

A Speedment bundle that shades all dependencies into one jar. This is useful when deploying an application on a server.

There is a newer version: 3.1.18

/**
 *
 * Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
 *
 * 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:
 *
 * http://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 com.speedment.runtime.join.trait;

import com.speedment.runtime.field.predicate.FieldPredicate;
import java.util.function.Predicate;

/**
 *
 * @author Per Minborg
 * @param  entity type
 * @param  return type
 */
public interface HasWhere {

    /**
     * Adds the provided {@code  predicate} to the collection of predicates that
     * shall be applied to entities from the previous Manager before entities
     * are accepted in the join.
     * 
     * Currently, only {@link FieldPredicate FieldPredicates } obtained by
     * Speedment predicate builders can be used in Join Operations. No anonymous
     * lambdas can be used.
     *
     * @param predicate to apply
     * @return a builder where the provided {@code predicate} is added
     *
     * @throws NullPointerException if the provided {@code predicate } is
     * {@code null}
     */
    R where(Predicate predicate);

}