io.micronaut.rss.RssFeedRenderer Maven / Gradle / Ivy

Go to download
/*
 * 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;

import java.io.Writer;

/**
 * Interface which defines the render of an {@link io.micronaut.rss.RssChannel} to {@link java.io.Writer}.
 *
 * @author Sergio del Amo
 * @since 1.0
 */
@FunctionalInterface
public interface RssFeedRenderer {
    /**
     * Writes an RSS channel to a {@link java.io.Writer}.
     * @param rssChannel The RSS channel to render
     * @param writer A Writer to write the RSS feed into
     */
    void render(Writer writer, RssChannel rssChannel);
}