io.micronaut.data.repository.async.AsyncPageableRepository Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-data-model Show documentation

Data Repository Support for Micronaut

The newest version!

/*
 * Copyright 2017-2022 original 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 io.micronaut.data.repository.async;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.data.model.Page;
import io.micronaut.data.model.Pageable;
import io.micronaut.data.model.Sort;

import java.util.concurrent.CompletableFuture;

/**
 * A repository that supports pagination.
 *
 * @param  The entity type
 * @param  The ID type
 * @author Denis Stepanov
 * @since 3.4.0
 */
public interface AsyncPageableRepository extends AsyncCrudRepository {

    /**
     * Find all results for the given sort order.
     *
     * @param sort The sort
     * @return The results publisher
     */
    @NonNull
    CompletableFuture findAll(@NonNull Sort sort);

    /**
     * Finds all records for the given pageable.
     *
     * @param pageable The pageable.
     * @return The results publisher
     */
    @NonNull
    CompletableFuture> findAll(@NonNull Pageable pageable);
}