Module pro.verron.officestamper
Package pro.verron.officestamper.api

Interface ObjectResolver

All Known Implementing Classes:
Resolvers.Null2DefaultResolver, StringResolver
public interface ObjectResolver
The ObjectResolver interface provides a contract for resolving objects to create a run with the resolved content. It includes methods to check if an object can be resolved and to actually resolve an object to a run.
Since:
1.6.7
Version:
${version}
Author:
Joseph Verron

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canResolve(Object object)
    Checks if the given object can be resolved.
    org.docx4j.wml.R
    resolve(org.docx4j.openpackaging.packages.WordprocessingMLPackage document, String expression, Object object)
    Resolves the expression in the given document with the provided object.
    default org.docx4j.wml.R
    resolve(org.docx4j.openpackaging.packages.WordprocessingMLPackage document, Placeholder placeholder, Object object)
    Resolves the expression in the given document with the provided object.

  • Method Details

    • resolve

      default org.docx4j.wml.R resolve(org.docx4j.openpackaging.packages.WordprocessingMLPackage document, Placeholder placeholder, Object object)
      Resolves the expression in the given document with the provided object.
      Parameters:
      document - the WordprocessingMLPackage document in which to resolve the expression
      placeholder - the expression value to be replaced
      object - the object to be used for resolving the expression
      Returns:
      the resolved value for the expression
      Throws:
      DocxStamperException - if no resolver is found for the object

    • canResolve

      boolean canResolve(@Nullable Object object)
      Checks if the given object can be resolved.
      Parameters:
      object - the object to be resolved
      Returns:
      true if the object can be resolved, false otherwise

    • resolve

      org.docx4j.wml.R resolve(org.docx4j.openpackaging.packages.WordprocessingMLPackage document, String expression, Object object)
      Resolves the expression in the given document with the provided object.
      Parameters:
      document - the WordprocessingMLPackage document in which to resolve the expression
      expression - the expression value to be replaced
      object - the object to be used for resolving the expression
      Returns:
      the resolved value for the expression
      Throws:
      DocxStamperException - if no resolver is found for the object