Release Notes
This page provides information about the latest releases of Office-stamper, including new features, bug fixes, and other changes.
Latest Release
v3.1.0
API Consolidation
- Public API: Moved
PlaceholderHooker,CommentHooker, andHookRemoverto thepro.verron.officestamper.apipackage for better accessibility and consistent extension points. - Experimental Features: All experimental stamper implementations are now located in the
pro.verron.officestamper.experimentalpackage.
Cleanup & Refinement
- Internal streamlining: Removed several internal utility classes (
SectionUtil,ParagraphCollector, etc.) to simplify the engine’s architecture. - Logging: Switched many verbose debug messages to trace level to reduce noise during normal development.
- Post-processing: Replaced
cleanTagswith the more powerfulPostprocessors.removeTags(String).
Previous Releases
v3.0.0
Core Overhaul
- Processing model overhaul: The engine now iterates "hooks" (placeholders, inline processors, comments) strictly in document order.
- New Hook concept: Each placeholder or comment is treated as a
Hook. The iterator walks hooks one by one, allowing for more predictable results. - Hierarchical Scopes:
ContextTreeresolves placeholders along the current branch; unresolved values bubble up to parent scopes. - Simplified Comment Processors: Processors are created per hook and executed once, with a fresh
ProcessorContext.
API Changes
- Moved API classes:
PlaceholderHooker,CommentHooker, andHookRemoverare now public in thepro.verron.officestamper.apipackage. - Renamed classes:
ContextDependentrenamed toHook. - Standard configuration:
OfficeStamperConfigurations.standard()now includes recommended preprocessors and post-processors by default. - Evaluation Context:
EvaluationContextConfigurerreplaced byEvaluationContextFactory. - Insert API: Introduced a new
InsertAPI for more flexible content insertion.
Dependencies
- Upgrade Java version to 25.
- Spring dependencies bumped to 7.0.2 (when available, currently tracking latest).
For information about previous releases, see the full release notes on GitHub.
Upgrading
From v3.0.0 to v3.1.0
- Package Moves: Update your imports for
PlaceholderHooker,CommentHooker, andHookRemovertopro.verron.officestamper.api. - Experimental API: If you used
ExperimentalStampers, it has moved topro.verron.officestamper.experimental. - Post-processing: Replace any usage of
cleanTagswithPostprocessors.removeTags(String). - Internal Classes: If you were using internal classes like
SectionUtil, they have been removed. You will need to implement this logic yourself if needed.
From v2.9.0 to v3.0.0
- Java 25 required: Ensure your project is running on Java 25 or higher.
- API Package: If you were using
PlaceholderHooker,CommentHooker, orHookRemoverfrom internal packages, update your imports topro.verron.officestamper.api. - Hooks: The engine now uses a "hook" based processing.
If you have custom processors, they now receive a
ProcessorContext. - Standard Configuration:
OfficeStamperConfigurations.standard()now includes preprocessing by default. You may no longer needstandardWithPreprocessing().
From v2.8.x to v2.9.0
- MAY (unlikely) BREAK some formatting after a replaceWordWith comment.
- Update your dependencies to the latest versions.
Reporting Issues
If you encounter any issues with a release, report them on the GitHub Issues page.
Next Steps
- Return to the Documentation Home
- See the Contributing guide if you want to help improve Office-stamper
verron.pro