io.micronaut.rss.jsonfeed.http.JsonFeedProvider Maven / Gradle / Ivy

Go to download

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

Eases the creation of RSS feeds with Micronaut

There is a newer version: 4.5.0

/*
 * Copyright 2017-2020 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.rss.jsonfeed.http;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.core.async.annotation.SingleResult;
import io.micronaut.rss.jsonfeed.JsonFeed;
import org.reactivestreams.Publisher;

/**
 * Defines a provider of a JSON Feed.
 *
 * @author Sergio del Amo
 * @author Graeme Rocher
 * @since 1.0
 */
public interface JsonFeedProvider {

    /**
     * Retrieves a JSON Feed. You can use the paramters `maxNumberOfItems` and `pageNumber` in combination with {@link JsonFeed#getNextURL()}
     * @param maxNumberOfItems desired max number of items in the the JSON Feed
     * @param pageNumber Page number to allow pagination in the JSON Feed Items.
     * @return A Json Feed
     */
    @NonNull
    @SingleResult
    Publisher feed(@Nullable Integer maxNumberOfItems,
                             @Nullable Integer pageNumber);

    /**
     * Retrieves a JSON Feed.
     * @return A Json Feed
     */
    @NonNull
    @SingleResult
    default Publisher feed() {
        return feed(null, null);
    }
}