com.vladsch.flexmark.formatter.PhasedNodeFormatter Maven / Gradle / Ivy

Go to download
package com.vladsch.flexmark.formatter;

import com.vladsch.flexmark.util.ast.Document;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.Set;

/**
 * A renderer for a document node for a specific rendering phase
 */
public interface PhasedNodeFormatter extends NodeFormatter {
    @Nullable Set getFormattingPhases();

    /**
     * Render the specified node.
     *
     * @param context  node renderer context instance
     * @param markdown markdown writer instance
     * @param document the document node to render
     * @param phase    rendering phase for which to generate the output. Will be any of {@link FormattingPhase} except {@link FormattingPhase#DOCUMENT} because this phase is used for the non-phased node rendering
     */
    void renderDocument(@NotNull NodeFormatterContext context, @NotNull MarkdownWriter markdown, @NotNull Document document, @NotNull FormattingPhase phase);
}