com.scalified.jpa.dsl.find.JpaFindBySpecificationDsl Maven / Gradle / Ivy

Go to download
/*
 * MIT License
 *
 * Copyright (c) 2018 Scalified
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

package com.scalified.jpa.dsl.find;

import com.scalified.jpa.function.ResultFunction;
import com.scalified.jpa.specification.Specification;

import java.util.List;
import java.util.Optional;
import java.util.Set;

/**
 * DSL for finding entities using {@link Specification}
 *
 * @author shell
 * @version 1.0.0
 * @since 1.0.0
 */
public interface JpaFindBySpecificationDsl {

	/**
	 * Returns a list of all found entities using {@link Specification}
	 *
	 * @return a list of all found entities
	 */
	List list();

	/**
	 * Returns a set of all found entities using {@link Specification}
	 *
	 * @return a set of all found entities
	 */
	Set set();

	/**
	 * Returns some generic result using {@link Specification}
	 * and after applying the specified resultFunction
	 *
	 * @param resultFunction a function to apply on result
	 * @param             type of generic result
	 * @return some generic result
	 */
	 R some(ResultFunction resultFunction);

	/**
	 * Returns the first found entity using {@link Specification}
	 *
	 * @return the first found entity
	 */
	Optional first();

}