com.speedment.field.methods.Streamer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of speedment Show documentation

There is a newer version: 3.0.0-EA

/**
 *
 * Copyright (c) 2006-2016, 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.field.methods;

import com.speedment.annotation.Api;
import java.util.function.Function;
import java.util.stream.Stream;

/**
 * A short-cut functional reference to the streaming {@code findXXXs()} method 
 * for a particular field referencing this entity.
 * 
 * A {@code Streamer} has the following signature:
 * 
 *      interface ENTITY {
 *          Stream<FK_ENTITY> findXXXs();
 *      }
 * 
 * 
 * @param      the entity
 * @param   the type of the foreign entity referencing this
 * 
 * @author  Emil Forslund
 * @since   2.2
 */
@Api(version = "2.3")
@FunctionalInterface
public interface Streamer extends 
    Function> {}