Class DocxStamperConfiguration

java.lang.Object

pro.verron.officestamper.core.DocxStamperConfiguration

All Implemented Interfaces:

OfficeStamperConfiguration

public class DocxStamperConfiguration
extends Object
implements OfficeStamperConfiguration

The DocxStamperConfiguration class represents the configuration for the DocxStamper class.

It provides methods to customize the behavior of the stamper.

Since:

1.0.3

Version:

${version}

Author:

Joseph Verron, Tom Hombergs

Constructor Summary

Constructors

Constructor	Description
DocxStamperConfiguration(EvaluationContextFactory evaluationContextFactory, ExceptionResolver exceptionResolver)	Constructs a new instance of the DocxStamperConfiguration class and initializes its default configuration settings.

Method Summary

Modifier and Type	Method	Description
DocxStamperConfiguration	addCommentProcessor(Class<?> interfaceClass, CommentProcessorFactory commentProcessorFactory)	Registers the specified CommentProcessor as an implementation of the specified interface.
<T> CustomFunction.NeedsFunctionImpl<T>	addCustomFunction(String name, Class<T> class0)	Adds a custom function to the context with the specified name and type.
<T,U> CustomFunction.NeedsBiFunctionImpl<T,U>	addCustomFunction(String name, Class<T> class0, Class<U> class1)	Adds a custom function with the specified name and input types.
<T,U,V> CustomFunction.NeedsTriFunctionImpl<T,U,V>	addCustomFunction(String name, Class<T> class0, Class<U> class1, Class<V> class2)	Adds a custom function to the current context by defining its name, and the classes associated with its argument types.
void	addCustomFunction(String name, Supplier<?> implementation)	Adds a custom function to the system, allowing integration of user-defined functionality.
void	addCustomFunction(CustomFunction function)	Adds a custom function to the list of functions.
void	addPostprocessor(PostProcessor postprocessor)	Adds a given postprocessor to the list of postprocessors.
void	addPreprocessor(PreProcessor preprocessor)	Adds a preprocessor to the configuration.
DocxStamperConfiguration	addResolver(ObjectResolver resolver)	Adds a resolver to the list of resolvers in the DocxStamperConfiguration object.
List<CustomFunction>	customFunctions()	Retrieves a list of custom functions.
DocxStamperConfiguration	exposeInterfaceToExpressionLanguage(Class<?> interfaceClass, Object implementation)	Exposes all methods of a given interface to the expression language.
Map<Class<?>, CommentProcessorFactory>	getCommentProcessors()	Retrieves the map of comment processors associated with specific classes.
EvaluationContextFactory	getEvaluationContextFactory()	Retrieves the configured EvaluationContextFactory instance.
ExceptionResolver	getExceptionResolver()	Retrieves the exception resolver.
Map<Class<?>,Object>	getExpressionFunctions()	Retrieves the mapping of expression function classes to their corresponding function instances.
org.springframework.expression.ExpressionParser	getExpressionParser()	Retrieves the expression parser used by the office stamper.
List<PostProcessor>	getPostprocessors()	Retrieves the list of postprocessors.
List<PreProcessor>	getPreprocessors()	Retrieves the list of preprocessors.
List<ObjectResolver>	getResolvers()	Retrieves the list of object resolvers.
void	resetCommentProcessors()	Resets all processors in the configuration.
void	resetResolvers()	Resets all resolvers in the configuration.
DocxStamperConfiguration	setEvaluationContextFactory(EvaluationContextFactory evaluationContextFactory)	Sets the EvaluationContextFactory which creates Spring EvaluationContext instances used for evaluating expressions in comments and text.
DocxStamperConfiguration	setExceptionResolver(ExceptionResolver exceptionResolver)	Configures the exception resolver for the DocxStamperConfiguration.
DocxStamperConfiguration	setExpressionParser(org.springframework.expression.ExpressionParser expressionParser)	Sets the expression parser used for expression evaluation.
DocxStamperConfiguration	setResolvers(List<ObjectResolver> resolvers)	Sets resolvers for resolving objects in the DocxStamperConfiguration.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DocxStamperConfiguration

public DocxStamperConfiguration(EvaluationContextFactory evaluationContextFactory,
 ExceptionResolver exceptionResolver)

Constructs a new instance of the DocxStamperConfiguration class and initializes its default configuration settings.

This constructor sets up internal structures and default behaviors for managing document stamping configurations, including:

• Initializing collections for processors, resolvers, and functions.
• Setting default values for expression handling and evaluation.
• Creating and configuring a default SpelParserConfiguration.
• Establishing resolvers and exception handling strategies.

Parameters:

evaluationContextFactory - the factory used to create EvaluationContext instances.

exceptionResolver - the exception resolver to use for handling exceptions during stamping.

Method Details

exposeInterfaceToExpressionLanguage

public DocxStamperConfiguration exposeInterfaceToExpressionLanguage(Class<?> interfaceClass,
 Object implementation)

Exposes all methods of a given interface to the expression language.

Specified by:

exposeInterfaceToExpressionLanguage in interface OfficeStamperConfiguration

Parameters:

interfaceClass - the interface holding methods to expose in the expression language.

implementation - the implementation to call to evaluate invocations of those methods, it must implement the mentioned interface.

Returns:

a DocxStamperConfiguration object

addCommentProcessor

public DocxStamperConfiguration addCommentProcessor(Class<?> interfaceClass,
 CommentProcessorFactory commentProcessorFactory)

Registers the specified CommentProcessor as an implementation of the specified interface.

Specified by:

addCommentProcessor in interface OfficeStamperConfiguration

Parameters:

interfaceClass - the interface, implemented by the commentProcessor.

commentProcessorFactory - the commentProcessor factory generating instances of the specified interface.

Returns:

a DocxStamperConfiguration object

addPreprocessor

public void addPreprocessor(PreProcessor preprocessor)

Adds a preprocessor to the configuration.

Specified by:

addPreprocessor in interface OfficeStamperConfiguration

Parameters:

preprocessor - the preprocessor to add.

getEvaluationContextFactory

public EvaluationContextFactory getEvaluationContextFactory()

Retrieves the configured EvaluationContextFactory instance.

Specified by:

getEvaluationContextFactory in interface OfficeStamperConfiguration

Returns:

an instance of EvaluationContextFactory used for creating evaluation contexts

setEvaluationContextFactory

public DocxStamperConfiguration setEvaluationContextFactory(EvaluationContextFactory evaluationContextFactory)

Sets the EvaluationContextFactory which creates Spring EvaluationContext instances used for evaluating expressions in comments and text.

Specified by:

setEvaluationContextFactory in interface OfficeStamperConfiguration

Parameters:

evaluationContextFactory - the factory to use.

Returns:

the configuration object for chaining.

getExpressionFunctions

public Map<Class<?>,Object> getExpressionFunctions()

Retrieves the mapping of expression function classes to their corresponding function instances.

Specified by:

getExpressionFunctions in interface OfficeStamperConfiguration

Returns:

a map where the keys are classes representing the function types, and the values are the function instances.

getCommentProcessors

public Map<Class<?>, CommentProcessorFactory> getCommentProcessors()

Retrieves the map of comment processors associated with specific classes.

Specified by:

getCommentProcessors in interface OfficeStamperConfiguration

Returns:

a map where the key is the class associated with a specific type of placeholder, and the value is a function that creates a CommentProcessor for that placeholder.

getPreprocessors

public List<PreProcessor> getPreprocessors()

Retrieves the list of preprocessors.

Specified by:

getPreprocessors in interface OfficeStamperConfiguration

Returns:

a list of PreProcessor objects.

getResolvers

public List<ObjectResolver> getResolvers()

Retrieves the list of object resolvers.

Specified by:

getResolvers in interface OfficeStamperConfiguration

Returns:

a list of ObjectResolver instances.

setResolvers

public DocxStamperConfiguration setResolvers(List<ObjectResolver> resolvers)

Sets resolvers for resolving objects in the DocxStamperConfiguration.

This method is the evolution of the method addResolver(ObjectResolver), and the order in which the resolvers are ordered is determinant; the first resolvers in the list will be tried first.

If a fallback resolver is desired, it should be placed last in the list.

Specified by:

setResolvers in interface OfficeStamperConfiguration

Parameters:

resolvers - The list of ObjectResolver to be set.

Returns:

the configuration object for chaining.

addResolver

public DocxStamperConfiguration addResolver(ObjectResolver resolver)

Adds a resolver to the list of resolvers in the DocxStamperConfiguration object.

Resolvers are used to resolve objects during the stamping process.

Specified by:

addResolver in interface OfficeStamperConfiguration

Parameters:

resolver - The resolver to be added.

Returns:

The modified DocxStamperConfiguration object, with the resolver added to the beginning of the resolver list.

getExceptionResolver

public ExceptionResolver getExceptionResolver()

Retrieves the exception resolver.

Specified by:

getExceptionResolver in interface OfficeStamperConfiguration

Returns:

the current instance of ExceptionResolver.

setExceptionResolver

public DocxStamperConfiguration setExceptionResolver(ExceptionResolver exceptionResolver)

Configures the exception resolver for the DocxStamperConfiguration.

Specified by:

setExceptionResolver in interface OfficeStamperConfiguration

Parameters:

exceptionResolver - the ExceptionResolver to handle exceptions during processing

Returns:

the current instance of DocxStamperConfiguration

customFunctions

public List<CustomFunction> customFunctions()

Retrieves a list of custom functions.

Specified by:

customFunctions in interface OfficeStamperConfiguration

Returns:

a List containing CustomFunction objects.

addCustomFunction

public void addCustomFunction(String name,
 Supplier<?> implementation)

Adds a custom function to the system, allowing integration of user-defined functionality.

Specified by:

addCustomFunction in interface OfficeStamperConfiguration

Parameters:

name - The name of the custom function being added. This is used as the identifier for the function and must be unique across all defined functions.

implementation - A Supplier functional interface that provides the implementation of the custom function. When the function is called, the supplier's get method will be executed to return the result of the function.

addCustomFunction

public void addCustomFunction(CustomFunction function)

Adds a custom function to the list of functions.

Parameters:

function - the CustomFunction object to be added

addCustomFunction

public <T> CustomFunction.NeedsFunctionImpl<T> addCustomFunction(String name,
 Class<T> class0)

Adds a custom function to the context with the specified name and type.

Specified by:

addCustomFunction in interface OfficeStamperConfiguration

Type Parameters:

T - the type of the input parameter

Parameters:

name - the name of the custom function

class0 - the class type of the custom function

Returns:

an instance of CustomFunction.NeedsFunctionImpl configured with the custom function

addCustomFunction

public <T,U>
CustomFunction.NeedsBiFunctionImpl<T,U> addCustomFunction(String name,
 Class<T> class0,
 Class<U> class1)

Adds a custom function with the specified name and input types.

Specified by:

addCustomFunction in interface OfficeStamperConfiguration

Type Parameters:

T - the type of the first input parameter

U - the type of the second input parameter

Parameters:

name - the name of the custom function to be added

class0 - the class type of the first input parameter of the custom function.

class1 - the class type of the second input parameter of the custom function.

Returns:

an instance of CustomFunction.NeedsBiFunctionImpl for further configuration or usage of the custom function.

addCustomFunction

public <T,U,V>
CustomFunction.NeedsTriFunctionImpl<T,U,V> addCustomFunction(String name,
 Class<T> class0,
 Class<U> class1,
 Class<V> class2)

Adds a custom function to the current context by defining its name, and the classes associated with its argument types.

Specified by:

addCustomFunction in interface OfficeStamperConfiguration

Type Parameters:

T - the type of the first argument

U - the type of the second argument

V - the type of the third argument

Parameters:

name - the name to assign to the custom function

class0 - the class of the first argument type

class1 - the class of the second argument type

class2 - the class of the third argument type

Returns:

an instance of CustomFunction.NeedsTriFunctionImpl indicating the custom function implementation and usage context.

getPostprocessors

public List<PostProcessor> getPostprocessors()

Retrieves the list of postprocessors.

Specified by:

getPostprocessors in interface OfficeStamperConfiguration

Returns:

a List of PostProcessor objects.

addPostprocessor

public void addPostprocessor(PostProcessor postprocessor)

Adds a given postprocessor to the list of postprocessors.

Specified by:

addPostprocessor in interface OfficeStamperConfiguration

Parameters:

postprocessor - the PostProcessor instance to be added

getExpressionParser

public org.springframework.expression.ExpressionParser getExpressionParser()

Description copied from interface: OfficeStamperConfiguration

Retrieves the expression parser used by the office stamper.

Specified by:

getExpressionParser in interface OfficeStamperConfiguration

Returns:

the ExpressionParser instance.

setExpressionParser

public DocxStamperConfiguration setExpressionParser(org.springframework.expression.ExpressionParser expressionParser)

Sets the expression parser used for expression evaluation.

Note that the provided parser will be used for all expressions in the document, including expressions in comments. If you use SpEL, construct a SpelExpressionParser (optionally with a SpelParserConfiguration) and pass it here.

Specified by:

setExpressionParser in interface OfficeStamperConfiguration

Parameters:

expressionParser - the parser to use.

Returns:

the configuration object for chaining.

resetCommentProcessors

public void resetCommentProcessors()

Resets all processors in the configuration.

resetResolvers

public void resetResolvers()

Resets all resolvers in the configuration.