io.dropwizard.views.common.ViewRenderer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dropwizard-views Show documentation

The newest version!

package io.dropwizard.views.common;

import jakarta.ws.rs.WebApplicationException;

import java.io.IOException;
import java.io.OutputStream;
import java.util.Locale;
import java.util.Map;

/**
 * The rendering engine for a type of view.
 */
public interface ViewRenderer {
    /**
     * Returns {@code true} if the renderer can render the given {@link View}.
     *
     * @param view a view
     * @return {@code true} if {@code view} can be rendered
     */
    boolean isRenderable(View view);

    /**
     * Renders the given {@link View} for the given {@link Locale} to the given {@link
     * OutputStream}.
     *
     * @param view   a view
     * @param locale the locale in which the view should be rendered
     * @param output the output stream
     * @throws IOException             if there is an error writing to {@code output}
     * @throws WebApplicationException if there is an error rendering the template
     */
    void render(View view,
                Locale locale,
                OutputStream output) throws IOException;

    /**
      * options for configuring the view renderer
      * @param options
     */
    void configure(Map options);

    /**
     * @return the key to use in the view configurations, i.e. 'freemarker' or 'mustache'.
     */
    String getConfigurationKey();
}