Package pro.verron.officestamper.api

@NullMarked package pro.verron.officestamper.api

Defines the core API for the library. Exposes types to manage document parts.

Ensures non-null values by default.

Class	Description
Comment	The Comment interface provides methods for managing comments in a document.
CommentHooker	The CommentHooker class is responsible for preparing comment processors in a Word document.
CommentHooker.CRSCollector	A collector class that gathers CommentRangeStart elements during document traversal.
CommentProcessor	Abstract base class for processing comments within a paragraph.
CommentProcessorFactory	A factory for creating CommentProcessor instances.
ContextTree	Represents a tree of contexts used for expression evaluation during document stamping.
CustomFunction	Represents a custom function encapsulating a name, parameter types, and a functional implementation.
CustomFunction.NeedsBiFunctionImpl<T,U>	Represents a contract for classes that require the implementation of a BiFunction.
CustomFunction.NeedsFunctionImpl<T>	The NeedsFunctionImpl interface specifies a contract for classes that require the implementation of a function that operates on a specific type and produces a result.
CustomFunction.NeedsTriFunctionImpl<T,U,V>	Represents a contract for classes requiring the implementation of a TriFunction.
DocxPart	Represents a part of a WordprocessingML-based document.
EvaluationContextFactory	Factory interface for creating EvaluationContext instances.
ExceptionResolver	ExceptionResolver is a functional interface used to resolve the behavior when an exception occurs during the processing of a placeholder.
Hook	Represents a hook that can be used to extend or customize the behavior of an OfficeStamper document processing flow.
HookRemover	A post-processor implementation that removes smart tags from a WordprocessingML document.
Hooks	Provides utility methods for working with Hook instances in the context of a WordprocessingML-based document.
Insert	The Insert record represents a container for managing collections of document elements that can be inserted into a DOCX document.
ObjectResolver	The ObjectResolver interface provides a contract for resolving objects to create a run with the resolved content.
OfficeStamper<T extends org.docx4j.openpackaging.packages.OpcPackage>	This is an interface that defines the contract for stamping templates with context and returning the result as a document.
OfficeStamperConfiguration	Interface representing the configuration for the Office Stamper functionality.
OfficeStamperException	OfficeStamperException is a subclass of RuntimeException that represents an exception that can be thrown during the processing of an Office document using the OfficeStamper library.
Paragraph	The Paragraph interface represents a paragraph in a text document.
PlaceholderHooker	The PlaceholderHooker class is a pre-processor that prepares inline placeholders in a WordprocessingML document.
PlaceholderHooker.ParagraphCollector	A TraversalUtilVisitor implementation that collects paragraphs matching a given pattern.
PostProcessor	The PostProcessor interface defines a contract for performing transformations or manipulations on instances of WordprocessingMLPackage.
PreProcessor	The PreProcessor interface defines a method for processing a WordprocessingMLPackage document prior to executing specific operations.
ProcessorContext	Represents a context within a document processing operation.
StreamStamper<T extends org.docx4j.openpackaging.packages.OpcPackage>	This class implements the functionality of an OfficeStamper meant for dealing with streams of data.
StringResolver<T>	This is an abstract class that provides a generic implementation for resolving objects to strings.
Table	Represents a table in a document that can be manipulated by the office stamper.
Table.Row	Represents a row within a table that can be manipulated by the office stamper.