main.java.pro.verron.officestamper.api.ParagraphPlaceholderReplacer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of engine Show documentation

Office-stamper is a Java template engine for docx documents, forked from org.wickedsource.docx-stamper

The newest version!

package pro.verron.officestamper.api;

import org.docx4j.openpackaging.packages.WordprocessingMLPackage;

/**
 * The ParagraphPlaceholderReplacer interface represents an object that can resolve expressions in a paragraph
 * and replace them with values provided by an expression resolver.
 */
public interface ParagraphPlaceholderReplacer {

    /**
     * Finds expressions in the given paragraph and replaces them with the values provided by the expression resolver.
     * 
     * Replace the previous {@link #resolveExpressionsForParagraph(Paragraph, Object, WordprocessingMLPackage)}
     *
     * @param docxPart  the docxPart in which to replace all expressions
     * @param paragraph the paragraph in which to replace expressions
     * @param context   the context root
     */
    default void resolveExpressionsForParagraph(
            DocxPart docxPart,
            Paragraph paragraph,
            Object context
    ) {
        resolveExpressionsForParagraph(paragraph, context, docxPart.document());
    }

    /**
     * Finds expressions in the given paragraph and replaces them with the values provided by the expression resolver.
     *
     * @param paragraph the paragraph in which to replace expressions
     * @param context   the context root
     * @param document  the document in which to replace all expressions
     *
     * @deprecated replaced by {@link #resolveExpressionsForParagraph(DocxPart, Paragraph, Object)}
     */
    @Deprecated(since = "2.3", forRemoval = true)
    void resolveExpressionsForParagraph(
            Paragraph paragraph,
            Object context,
            WordprocessingMLPackage document
    );
}