void render()

in doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderer.java [46:112]

• 15 lines of code
• 1 McCabe index (conditional complexity)

    void render(Collection<DocumentRenderer> documents, SiteRenderingContext siteRenderingContext, File outputDirectory)
            throws RendererException, IOException;

    /**
     * Generate a document output integrated in a site from a document content,
     * i.e. merge the document content into the site template.
     *
     * @param writer the Writer to use.
     * @param content the document content to be merged.
     * @param siteRenderingContext the SiteRenderingContext to use.
     * @throws IOException if it bombs.
     * @throws RendererException if it bombs.
     * @since 1.8
     */
    void mergeDocumentIntoSite(Writer writer, DocumentContent content, SiteRenderingContext siteRenderingContext)
            throws IOException, RendererException;

    /**
     * Create a Site Rendering Context for a site using a skin.
     *
     * @param skin a skin
     * @param attributes attributes to use
     * @param siteModel a site model
     * @param defaultTitle default title
     * @param locale locale to use
     * @return a SiteRenderingContext.
     * @throws RendererException if it bombs.
     * @throws java.io.IOException if it bombs.
     * @since 1.7.3 was previously with skin as File instead of Artifact
     */
    SiteRenderingContext createContextForSkin(
            Artifact skin, Map<String, ?> attributes, SiteModel siteModel, String defaultTitle, Locale locale)
            throws RendererException, IOException;

    /**
     * Copy resource files from skin, template, and site resources.
     *
     * @param siteRenderingContext the SiteRenderingContext to use.
     * @param outputDirectory output directory as file
     * @throws IOException if it bombs.
     * @since 1.7
     */
    void copyResources(SiteRenderingContext siteRenderingContext, File outputDirectory) throws IOException;

    /**
     * Locate Doxia document source files in the site source context.
     *
     * @param siteRenderingContext the SiteRenderingContext to use
     * @return the Doxia document renderers in a Map keyed by output file path.
     * @throws IOException if it bombs.
     * @throws RendererException if it bombs.
     * @since 2.0.0
     */
    Map<String, DocumentRenderer> locateDocumentFiles(SiteRenderingContext siteRenderingContext)
            throws IOException, RendererException;

    /**
     * @see #locateDocumentFiles(SiteRenderingContext)
     * @deprecated {@code editable} parameter is ignored since {@link SiteRenderingContext#getSiteDirectories()}
     *             contain this information on a per-directory basis now.
     * @since 1.8
     */
    @Deprecated
    default Map<String, DocumentRenderer> locateDocumentFiles(
            SiteRenderingContext siteRenderingContext, boolean editable) throws IOException, RendererException {
        return locateDocumentFiles(siteRenderingContext);
    }