Index (Office-stamper engine 3.1 API)

A B C D E F G H I L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Serialized Form

A

add(int, Table.Row) - Method in interface pro.verron.officestamper.api.Table: Adds a row to the table at the specified index.
add(int, Table.Row) - Method in class pro.verron.officestamper.core.StandardTable
addAll(int, List) - Method in interface pro.verron.officestamper.api.Table: Adds all the given rows to the table starting at the specified index.
addAll(int, List) - Method in class pro.verron.officestamper.core.StandardTable
addBranch(Object) - Method in interface pro.verron.officestamper.api.ContextTree: Adds a new branch to the context tree with the specified sub-context object.
addBranch(Object) - Method in class pro.verron.officestamper.core.ContextBranch: Adds a new branch with the given object.
addBranch(Object) - Method in class pro.verron.officestamper.core.ContextRoot
addBranch(ContextBranch) - Method in class pro.verron.officestamper.core.ContextRoot: Adds a branch to the root.
addCommentProcessor(Class, CommentProcessorFactory) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Adds a comment processor to the OfficeStamperConfiguration.
addCommentProcessor(Class, CommentProcessorFactory) - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Registers the specified CommentProcessor as an implementation of the specified interface.
addCustomFunction(String, Class) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Adds a custom function with the specified name and associated class type.
addCustomFunction(String, Class) - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Adds a custom function to the context with the specified name and type.
addCustomFunction(String, Class, Class) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Adds a custom bi-function with the specified name and the provided parameter types.
addCustomFunction(String, Class, Class) - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Adds a custom function with the specified name and input types.
addCustomFunction(String, Class, Class, Class) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Adds a custom function with the specified parameters.
addCustomFunction(String, Class, Class, Class) - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Adds a custom function to the current context by defining its name, and the classes associated with its argument types.
addCustomFunction(String, Supplier) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Adds a custom function to the system with the specified name and implementation.
addCustomFunction(String, Supplier) - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Adds a custom function to the system, allowing integration of user-defined functionality.
addCustomFunction(CustomFunction) - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Adds a custom function to the list of functions.
addPostprocessor(PostProcessor) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Adds a postprocessor to modify or enhance data or operations during the processing lifecycle.
addPostprocessor(PostProcessor) - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Adds a given postprocessor to the list of postprocessors.
addPreprocessor(PreProcessor) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Adds a pre-processor to the OfficeStamperConfiguration.
addPreprocessor(PreProcessor) - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Adds a preprocessor to the configuration.
addResolver(ObjectResolver) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Adds an ObjectResolver to the OfficeStamperConfiguration.
addResolver(ObjectResolver) - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Adds a resolver to the list of resolvers in the DocxStamperConfiguration object.
apply(Consumer) - Method in interface pro.verron.officestamper.api.Paragraph: Applies the specified consumer function to the paragraph content.
apply(Consumer) - Method in class pro.verron.officestamper.core.StandardParagraph: Applies the given consumer to the paragraph represented by the current instance.
apply(Consumer) - Method in class pro.verron.officestamper.experimental.PowerpointParagraph
apply(CommentRangeStart) - Method in class pro.verron.officestamper.api.CommentHooker.CRSCollector
apply(P) - Method in class pro.verron.officestamper.api.PlaceholderHooker.ParagraphCollector
args() - Method in record class pro.verron.officestamper.core.Invoker: Returns the value of the args record component.
Args(List) - Constructor for record class pro.verron.officestamper.core.Invokers.Args: Creates an instance of a Args record class.
asComment() - Method in record class pro.verron.officestamper.core.Tag: Converts the current tag entity into a Comment representation.
asHook(DocxPart, Object) - Static method in interface pro.verron.officestamper.core.DocxHook: Converts an object to a hook.
asString() - Method in interface pro.verron.officestamper.api.Paragraph: Returns the paragraph as a string.
asString() - Method in class pro.verron.officestamper.core.StandardParagraph: Returns the aggregated text over all runs.
asString() - Method in class pro.verron.officestamper.experimental.ExcelParagraph: Returns the aggregated text over all runs.
asString() - Method in class pro.verron.officestamper.experimental.PowerpointParagraph: Returns the aggregated text over all runs.
asTr() - Method in interface pro.verron.officestamper.api.Table.Row: Returns the underlying docx4j Tr object.
asTr() - Method in class pro.verron.officestamper.core.StandardRow

B

before(Object) - Method in class pro.verron.officestamper.experimental.ExcelCollector: This method is called before visiting an object in the ExcelCollector class.
before(Object) - Method in class pro.verron.officestamper.experimental.PowerpointCollector

C

canRead(EvaluationContext, Object, String) - Method in class pro.verron.officestamper.preset.MapAccessor
canResolve(Object) - Method in interface pro.verron.officestamper.api.ObjectResolver: Checks if the given object can be resolved.
canResolve(Object) - Method in class pro.verron.officestamper.api.StringResolver: Determines if the given object can be resolved by the StringResolver.
canWrite(EvaluationContext, Object, String) - Method in class pro.verron.officestamper.preset.MapAccessor
collect() - Method in class pro.verron.officestamper.experimental.ExcelCollector: Returns a List containing the collected objects.
collect() - Method in class pro.verron.officestamper.experimental.PowerpointCollector: Retrieves the collected instances of a specific class.
collect(Object, Class) - Static method in class pro.verron.officestamper.experimental.ExcelCollector: Collects objects of a specific type from an Excel file.
collect(Object, Class) - Static method in class pro.verron.officestamper.experimental.PowerpointCollector: Collects instances of a specific class in a PowerPoint presentation.
comment() - Method in class pro.verron.officestamper.api.CommentProcessor: Returns the comment associated with this processor.
comment() - Method in class pro.verron.officestamper.api.ProcessorContext: Returns the comment associated with the current processing context.
comment(DocxPart, CommentRangeStart, WordprocessingMLPackage, ContentAccessor) - Static method in class pro.verron.officestamper.core.CommentUtil: Creates a Comment object.
Comment - Interface in pro.verron.officestamper.api: The Comment interface provides methods for managing comments in a document.
CommentHook - Class in pro.verron.officestamper.core: A hook that processes comments in a document.
CommentHooker - Class in pro.verron.officestamper.api: The CommentHooker class is responsible for preparing comment processors in a Word document.
CommentHooker() - Constructor for class pro.verron.officestamper.api.CommentHooker: Default constructor for CommentHooker.
CommentHooker.CRSCollector - Class in pro.verron.officestamper.api: A collector class that gathers CommentRangeStart elements during document traversal.
CommentProcessor - Class in pro.verron.officestamper.api: Abstract base class for processing comments within a paragraph.
CommentProcessor(ProcessorContext) - Constructor for class pro.verron.officestamper.api.CommentProcessor: Constructs a new instance of CommentProcessor to process comments and placeholders within a paragraph.
CommentProcessorFactory - Class in pro.verron.officestamper.preset: Factory class to create the correct comment processor for a given comment.
CommentProcessorFactory - Interface in pro.verron.officestamper.api: A factory for creating CommentProcessor instances.
CommentProcessorFactory.IDisplayIfProcessor - Interface in pro.verron.officestamper.preset: Interface for processors used to delete paragraphs or tables from the document, depending on condition.
CommentProcessorFactory.IParagraphRepeatProcessor - Interface in pro.verron.officestamper.preset: An interface that defines a processor for repeating a paragraph for each element present in the given iterable collection of objects.
CommentProcessorFactory.IRepeatDocPartProcessor - Interface in pro.verron.officestamper.preset: An interface that defines a processor for repeating a document part for each element present in the given iterable collection of objects.
CommentProcessorFactory.IRepeatProcessor - Interface in pro.verron.officestamper.preset: An interface that defines a processor for repeating content for each element present in the given iterable collection of objects.
CommentProcessorFactory.IRepeatRowProcessor - Interface in pro.verron.officestamper.preset: An interface that defines a processor for repeating a table row for each element present in the given iterable collection of objects.
CommentProcessorFactory.IReplaceWithProcessor - Interface in pro.verron.officestamper.preset: Interface for processors that replace a single word with an expression defined in a comment.
CommentProcessorFactory.ITableResolver - Interface in pro.verron.officestamper.preset: Used to resolve a table in the template document.
commentRangeStarts() - Method in class pro.verron.officestamper.api.CommentHooker.CRSCollector: Returns the list of collected CommentRangeStart elements.
CommentUtil - Class in pro.verron.officestamper.core: Utility class for working with comments in a DOCX document.
content() - Method in interface pro.verron.officestamper.api.DocxPart: Retrieves the content of the WordprocessingML-based document as a list of objects.
content() - Method in class pro.verron.officestamper.core.TextualDocxPart: Retrieves the list of content objects associated with this document part.
content() - Method in interface pro.verron.officestamper.experimental.Placeholder: Returns the content of the placeholder.
content() - Method in record class pro.verron.officestamper.experimental.StandardPlaceholder: Retrieves the processed content of the placeholder.
contentIterator() - Method in class pro.verron.officestamper.api.ProcessorContext: Returns an iterator over the content associated with the current comment's range.
context() - Method in class pro.verron.officestamper.api.CommentProcessor: Returns the processing context for this CommentProcessor instance.
ContextBranch - Class in pro.verron.officestamper.core: A branch in the context tree.
ContextBranch(ContextRoot, Object) - Constructor for class pro.verron.officestamper.core.ContextBranch: Constructs a ContextBranch with a single root object.
ContextBranch(ContextRoot, List) - Constructor for class pro.verron.officestamper.core.ContextBranch: Constructs a ContextBranch with a list of objects forming the branch.
contextHolder() - Method in class pro.verron.officestamper.api.ProcessorContext: Returns the context tree managing the hierarchical scopes for this context.
ContextRoot - Class in pro.verron.officestamper.core: The root of the context tree.
ContextRoot(Object) - Constructor for class pro.verron.officestamper.core.ContextRoot: Constructs a ContextRoot with the given root object.
ContextTree - Interface in pro.verron.officestamper.api: Represents a tree of contexts used for expression evaluation during document stamping.
copy() - Method in interface pro.verron.officestamper.api.Table.Row: Creates a deep copy of this row.
copy() - Method in class pro.verron.officestamper.core.StandardRow
create(Object) - Method in interface pro.verron.officestamper.api.EvaluationContextFactory: Creates an evaluation context for the given context root.
create(DocxPart, ContentAccessor, String, BigInteger) - Static method in class pro.verron.officestamper.core.StandardComment: Creates a new instance of StandardComment and initializes it with the given parameters, including a comment, comment range start, comment range end, and a comment reference.
create(ProcessorContext) - Method in interface pro.verron.officestamper.api.CommentProcessorFactory: Creates a new CommentProcessor instance.
create(ProcessorContext) - Method in interface pro.verron.officestamper.core.EngineFactory: Creates an instance of the Engine class based on the provided ProcessorContext.
create(ProcessorContext, ContextBranch) - Method in class pro.verron.officestamper.core.OfficeStamperEvaluationContextFactory: Creates an evaluation context.
CRSCollector() - Constructor for class pro.verron.officestamper.api.CommentHooker.CRSCollector: Default constructor for CRSCollector.
CustomFunction - Record Class in pro.verron.officestamper.api: Represents a custom function encapsulating a name, parameter types, and a functional implementation.
CustomFunction(String, List, Function) - Constructor for record class pro.verron.officestamper.api.CustomFunction: Creates an instance of a CustomFunction record class.
CustomFunction.NeedsBiFunctionImpl<T,U> - Interface in pro.verron.officestamper.api: Represents a contract for classes that require the implementation of a BiFunction.
CustomFunction.NeedsFunctionImpl<T> - Interface in pro.verron.officestamper.api: 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> - Interface in pro.verron.officestamper.api: Represents a contract for classes requiring the implementation of a TriFunction.
customFunctions() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves a list of custom functions.
customFunctions() - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Retrieves a list of custom functions.

D

defaultFactory() - Static method in class pro.verron.officestamper.preset.EvaluationContextFactories: Returns a default EvaluationContextFactory instance.
defaulting() - Static method in class pro.verron.officestamper.preset.ExceptionResolvers: The defaulting resolver class will handle exceptions by returning an empty string.
defaulting(String) - Static method in class pro.verron.officestamper.preset.ExceptionResolvers: The defaulting resolver class will handle exceptions by returning a default value.
deleteComment(Comment) - Static method in class pro.verron.officestamper.core.CommentUtil: Returns the string value of the specified comment object.
depthElementSearch(Object, Object) - Static method in class pro.verron.officestamper.core.DocumentUtil: Recursively searches for an element in a content tree.
displayDocPartIf(Boolean) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: Displays or removes the selected elements surrounding a specific comment in a document based on the given condition.
displayDocPartIfAbsent(Object) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: Displays or removes the selected elements surrounding a specific comment in a document based on the given condition.
displayDocPartIfPresent(Object) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: Displays or removes the selected elements surrounding a specific comment in a document based on the given condition.
displayParagraphIf(Boolean) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: Displays or removes the paragraph surrounding a specific comment in a document based on the given condition.
displayParagraphIfAbsent(Object) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: Displays or removes the paragraph surrounding a specific comment in a document based on the given condition.
displayParagraphIfPresent(Object) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: Displays or removes the paragraph surrounding a specific comment in a document based on the given condition.
displayTableIf(Boolean) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: Displays or removes the table surrounding a specific comment in a document based on the given condition.
displayTableIfAbsent(Object) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: Displays or removes the table surrounding a specific comment in a document based on the given condition.
displayTableIfPresent(Object) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: Displays or removes the table surrounding a specific comment in a document based on the given condition.
displayTableRowIf(Boolean) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: Displays or removes the table row surrounding a specific comment in a document based on the given condition.
displayTableRowIfAbsent(Object) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: Displays or removes the table row surrounding a specific comment in a document based on the given condition.
displayTableRowIfPresent(Object) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: Displays or removes the table row surrounding a specific comment in a document based on the given condition.
displayWordsIf(Boolean) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: Displays or removes the selected words surrounding a specific comment in a document based on the given condition.
displayWordsIfAbsent(Object) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: Displays or removes the selected words surrounding a specific comment in a document based on the given condition.
displayWordsIfPresent(Object) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: Displays or removes the selected words surrounding a specific comment in a document based on the given condition.
document() - Method in interface pro.verron.officestamper.api.DocxPart: Retrieves the WordprocessingMLPackage representing the entire document.
document() - Method in class pro.verron.officestamper.core.TextualDocxPart: Returns the WordprocessingMLPackage instance representing the document associated with this part.
document() - Method in record class pro.verron.officestamper.experimental.PptxPart: Returns the value of the document record component.
DocumentUtil - Class in pro.verron.officestamper.core: Utility class to retrieve elements from a document.
DocxHook - Interface in pro.verron.officestamper.core: Interface for hooks that process specific parts of a DOCX document.
docxPackageStamper(OfficeStamperConfiguration) - Static method in class pro.verron.officestamper.preset.OfficeStampers: Creates an OfficeStamper instance for processing WordprocessingMLPackage documents with the specified configuration.
docxPart() - Method in record class pro.verron.officestamper.core.Tag: Returns the value of the docxPart record component.
DocxPart - Interface in pro.verron.officestamper.api: Represents a part of a WordprocessingML-based document.
docxStamper() - Static method in class pro.verron.officestamper.preset.OfficeStampers: Creates a new instance of a StreamStamper for handling WordprocessingMLPackage documents with a default full configuration.
docxStamper(OfficeStamperConfiguration) - Static method in class pro.verron.officestamper.preset.OfficeStampers: Creates a StreamStamper instance that processes WordprocessingMLPackage (DOCX) documents by applying stamping with the given configuration.
DocxStamper - Class in pro.verron.officestamper.core: The DocxStamper class is an implementation of the OfficeStamper interface used to stamp DOCX templates with a context object and write the result to an output stream.
DocxStamper(OfficeStamperConfiguration) - Constructor for class pro.verron.officestamper.core.DocxStamper: Creates new DocxStamper with the given configuration.
DocxStamperConfiguration - Class in pro.verron.officestamper.core: The DocxStamperConfiguration class represents the configuration for the DocxStamper class.
DocxStamperConfiguration(EvaluationContextFactory, ExceptionResolver) - Constructor for class pro.verron.officestamper.core.DocxStamperConfiguration: Constructs a new instance of the DocxStamperConfiguration class and initializes its default configuration settings.

E

elements() - Method in record class pro.verron.officestamper.api.Insert: Returns the value of the elements record component.
empty() - Static method in class pro.verron.officestamper.preset.StampTable: Creates an empty table with a single placeholder column and row
endIndex() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Returns the value of the endIndex record component.
Engine - Class in pro.verron.officestamper.core: The core engine of OfficeStamper, responsible for processing expressions.
Engine(ExpressionParser, ExceptionResolver, ObjectResolverRegistry, ProcessorContext) - Constructor for class pro.verron.officestamper.core.Engine: Constructs an Engine.
EngineFactory - Interface in pro.verron.officestamper.core: A functional interface responsible for creating instances of the Engine class.
equals(Object) - Method in record class pro.verron.officestamper.api.CustomFunction: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class pro.verron.officestamper.api.Insert: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class pro.verron.officestamper.core.Invoker: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class pro.verron.officestamper.core.Invokers.Args: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class pro.verron.officestamper.core.Matcher: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class pro.verron.officestamper.core.ReflectionExecutor: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class pro.verron.officestamper.core.Tag: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class pro.verron.officestamper.core.UnionEvaluationContext
equals(Object) - Method in record class pro.verron.officestamper.experimental.PlaceholderFinder: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class pro.verron.officestamper.experimental.PptxPart: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class pro.verron.officestamper.experimental.StandardPlaceholder: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class pro.verron.officestamper.preset.StampTable
evaluationContext() - Method in class pro.verron.officestamper.core.UnionEvaluationContext: Returns the wrapped evaluation context.
EvaluationContextFactories - Class in pro.verron.officestamper.preset: Utility class for configuring the EvaluationContext used by officestamper.
EvaluationContextFactory - Interface in pro.verron.officestamper.api: Factory interface for creating EvaluationContext instances.
ExcelCollector<T> - Class in pro.verron.officestamper.experimental: The ExcelCollector class is used to collect objects of a specific type from an Excel file.
ExcelCollector(Class) - Constructor for class pro.verron.officestamper.experimental.ExcelCollector: Constructs a new ExcelCollector object with the given type.
ExcelParagraph - Class in pro.verron.officestamper.experimental: The ExcelParagraph class represents a paragraph in an Excel document.
ExcelParagraph(CTRst) - Constructor for class pro.verron.officestamper.experimental.ExcelParagraph: Constructs a new ParagraphWrapper for the given paragraph.
ExcelStamper - Class in pro.verron.officestamper.experimental: The ExcelStamper class is an implementation of the OfficeStamper interface for stamping Excel templates.
ExcelStamper() - Constructor for class pro.verron.officestamper.experimental.ExcelStamper: Default constructor for the ExcelStamper class.
ExceptionResolver - Interface in pro.verron.officestamper.api: ExceptionResolver is a functional interface used to resolve the behavior when an exception occurs during the processing of a placeholder.
ExceptionResolvers - Class in pro.verron.officestamper.preset: The ExceptionResolvers class provides a set of static factory methods to create different types of ExceptionResolver implementations.
execute(EvaluationContext, Object, Object...) - Method in record class pro.verron.officestamper.core.ReflectionExecutor: Executes the provided method on the given object using the specified arguments.
executor() - Method in record class pro.verron.officestamper.core.Invoker: Returns the value of the executor record component.
ExperimentalStampers - Class in pro.verron.officestamper.experimental: ExperimentalStampers is a class that provides static methods for obtaining instances of OfficeStamper implementations for stamping PowerPoint presentations and Excel templates with context and writing the result to an OutputStream.
exposeInterfaceToExpressionLanguage(Class, Object) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Exposes an interface to the expression language.
exposeInterfaceToExpressionLanguage(Class, Object) - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Exposes all methods of a given interface to the expression language.
expression() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the expression associated with the implementing entity.
expression() - Method in class pro.verron.officestamper.api.ProcessorContext: Returns the expression or directive currently being evaluated.
expression() - Method in class pro.verron.officestamper.core.StandardComment
expression() - Method in record class pro.verron.officestamper.core.Tag: Retrieves the expression of the tag.
expression() - Method in interface pro.verron.officestamper.experimental.Placeholder: Retrieves the expression of the placeholder.
expression() - Method in record class pro.verron.officestamper.experimental.StandardPlaceholder: Returns the value of the expression record component.
extractContent(CommentsPart) - Static method in class pro.verron.officestamper.core.CommentUtil: Extracts the contents of a given CommentsPart.

F

fallback(String) - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that can act as a fallback resolver.
find(String) - Method in class pro.verron.officestamper.core.ContextRoot: Finds a branch by its key.
find(String) - Method in record class pro.verron.officestamper.experimental.PlaceholderFinder: Finds expressions in a given text based on a specified pattern and matcher.
findProcessors(String) - Static method in class pro.verron.officestamper.experimental.Placeholders: Finds processors expressions in a given text.
findSmallestCommonParent(Object, Object) - Static method in class pro.verron.officestamper.core.DocumentUtil: Finds the smallest common parent between two objects.
findVariables(String) - Static method in class pro.verron.officestamper.experimental.Placeholders: Finds variable expressions in a given text.
findVariables(Paragraph) - Static method in class pro.verron.officestamper.experimental.Placeholders: Finds variable expressions in a given paragraph.
from(DocxPart, Object) - Static method in class pro.verron.officestamper.core.StandardParagraph: Creates a new instance of StandardParagraph from the provided DocxPart and parent object.
from(DocxPart, CTSdtContentRun) - Static method in class pro.verron.officestamper.core.StandardParagraph: Creates a new instance of StandardParagraph from the provided DocxPart and CTSdtContentRun objects.
from(DocxPart, P) - Static method in class pro.verron.officestamper.core.StandardParagraph: Creates a new instance of StandardParagraph using the provided DocxPart and P objects.
full() - Static method in class pro.verron.officestamper.preset.OfficeStamperConfigurations: Creates a full OfficeStamperConfiguration with standard configurations, supplemented with additional pre- and post-processors for enhanced document handling.
function() - Method in record class pro.verron.officestamper.api.CustomFunction: Returns the value of the function record component.

G

getBeanResolver() - Method in class pro.verron.officestamper.core.UnionEvaluationContext
getComment() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the comment associated with this object.
getComment() - Method in interface pro.verron.officestamper.api.Paragraph: Retrieves a collection of comments associated with the paragraph.
getComment() - Method in class pro.verron.officestamper.core.StandardComment
getComment() - Method in class pro.verron.officestamper.core.StandardParagraph: Retrieves the collection of comments associated with the current paragraph.
getComment() - Method in class pro.verron.officestamper.experimental.PowerpointParagraph
getCommentFor(ContentAccessor, OpcPackage) - Static method in class pro.verron.officestamper.core.CommentUtil: Retrieves the comment associated with a given paragraph content within a WordprocessingMLPackage document.
getCommentProcessors() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Returns a map of comment processors associated with their respective classes.
getCommentProcessors() - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Retrieves the map of comment processors associated with specific classes.
getCommentRangeEnd() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the CommentRangeEnd object associated with this comment.
getCommentRangeEnd() - Method in class pro.verron.officestamper.core.StandardComment
getCommentRangeStart() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the CommentRangeStart object associated with this comment.
getCommentRangeStart() - Method in class pro.verron.officestamper.core.StandardComment
getCommentReference() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the R.CommentReference object associated with this comment.
getCommentReference() - Method in class pro.verron.officestamper.core.StandardComment
getCommentsPart(Parts) - Static method in class pro.verron.officestamper.core.CommentUtil: Retrieves the CommentsPart from the given Parts object.
getConstructorResolvers() - Method in class pro.verron.officestamper.core.UnionEvaluationContext
getContextKey() - Method in record class pro.verron.officestamper.core.Tag: Retrieves the context key of the tag.
getElements() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the elements in the document that are between the comment range anchors.
getElements() - Method in class pro.verron.officestamper.core.StandardComment
getEvaluationContextFactory() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the EvaluationContextFactory for creating Spring Expression Language (SpEL) EvaluationContext instances used by the office stamper.
getEvaluationContextFactory() - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Retrieves the configured EvaluationContextFactory instance.
getExceptionResolver() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the instance of the ExceptionResolver.
getExceptionResolver() - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Retrieves the exception resolver.
getExpressionFunctions() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the map of expression functions associated with their corresponding classes.
getExpressionFunctions() - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Retrieves the mapping of expression function classes to their corresponding function instances.
getExpressionParser() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the expression parser used by the office stamper.
getExpressionParser() - Method in class pro.verron.officestamper.core.DocxStamperConfiguration
getId() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the ID of this comment.
getId() - Method in class pro.verron.officestamper.core.StandardComment
getIndexAccessors() - Method in class pro.verron.officestamper.core.UnionEvaluationContext
getMethodResolvers() - Method in class pro.verron.officestamper.core.UnionEvaluationContext
getOperatorOverloader() - Method in class pro.verron.officestamper.core.UnionEvaluationContext
getParagraph() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the paragraph associated with this comment.
getParagraph() - Method in class pro.verron.officestamper.core.StandardComment
getParagraph() - Method in record class pro.verron.officestamper.core.Tag: Retrieves the paragraph associated with the smart tag's parent element.
getParent() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the parent of the comment.
getParent() - Method in class pro.verron.officestamper.core.StandardComment
getPostprocessors() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the list of post-processors associated with this instance.
getPostprocessors() - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Retrieves the list of postprocessors.
getPreprocessors() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the list of pre-processors.
getPreprocessors() - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Retrieves the list of preprocessors.
getPropertyAccessors() - Method in class pro.verron.officestamper.core.UnionEvaluationContext
getResolvers() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the list of ObjectResolvers.
getResolvers() - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Retrieves the list of object resolvers.
getRootObject() - Method in class pro.verron.officestamper.core.UnionEvaluationContext
getSpecificTargetClasses() - Method in class pro.verron.officestamper.preset.MapAccessor
getStartTagRun() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the CTSmartTagRun object associated with the start of this comment.
getStartTagRun() - Method in class pro.verron.officestamper.core.StandardComment
getTypeComparator() - Method in class pro.verron.officestamper.core.UnionEvaluationContext
getTypeConverter() - Method in class pro.verron.officestamper.core.UnionEvaluationContext
getTypeLocator() - Method in class pro.verron.officestamper.core.UnionEvaluationContext

H

hashCode() - Method in record class pro.verron.officestamper.api.CustomFunction: Returns a hash code value for this object.
hashCode() - Method in record class pro.verron.officestamper.api.Insert: Returns a hash code value for this object.
hashCode() - Method in record class pro.verron.officestamper.core.Invoker: Returns a hash code value for this object.
hashCode() - Method in record class pro.verron.officestamper.core.Invokers.Args: Returns a hash code value for this object.
hashCode() - Method in record class pro.verron.officestamper.core.Matcher: Returns a hash code value for this object.
hashCode() - Method in record class pro.verron.officestamper.core.ReflectionExecutor: Returns a hash code value for this object.
hashCode() - Method in record class pro.verron.officestamper.core.Tag: Returns a hash code value for this object.
hashCode() - Method in class pro.verron.officestamper.core.UnionEvaluationContext
hashCode() - Method in record class pro.verron.officestamper.experimental.PlaceholderFinder: Returns a hash code value for this object.
hashCode() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Returns a hash code value for this object.
hashCode() - Method in record class pro.verron.officestamper.experimental.PptxPart: Returns a hash code value for this object.
hashCode() - Method in record class pro.verron.officestamper.experimental.StandardPlaceholder: Returns a hash code value for this object.
hashCode() - Method in class pro.verron.officestamper.preset.StampTable
headers() - Method in class pro.verron.officestamper.preset.StampTable: Gets the headers of the table
Hook - Interface in pro.verron.officestamper.api: Represents a hook that can be used to extend or customize the behavior of an OfficeStamper document processing flow.
HookRemover - Class in pro.verron.officestamper.api: A post-processor implementation that removes smart tags from a WordprocessingML document.
HookRemover(String) - Constructor for class pro.verron.officestamper.api.HookRemover: Constructs a new HookRemover with the specified element name.
hooks() - Method in interface pro.verron.officestamper.api.Table.Row: Returns the hooks associated with this row.
hooks() - Method in class pro.verron.officestamper.core.StandardRow
Hooks - Class in pro.verron.officestamper.api: Provides utility methods for working with Hook instances in the context of a WordprocessingML-based document.

I

image() - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves Image to an actual image in the resulting .docx document.
Image - Class in pro.verron.officestamper.preset: This class describes an image, which will be inserted into a document.
Image(byte[]) - Constructor for class pro.verron.officestamper.preset.Image: Constructor for Image.
Image(byte[], Integer) - Constructor for class pro.verron.officestamper.preset.Image: Constructor for Image.
Image(byte[], Integer, String, String) - Constructor for class pro.verron.officestamper.preset.Image: Constructor for Image.
Image(InputStream) - Constructor for class pro.verron.officestamper.preset.Image: Constructor for Image.
Image(InputStream, Integer) - Constructor for class pro.verron.officestamper.preset.Image: Constructor for Image.
indexInParent() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Returns the value of the indexInParent record component.
indexOf(Table.Row) - Method in interface pro.verron.officestamper.api.Table: Returns the index of the given row within the table.
indexOf(Table.Row) - Method in class pro.verron.officestamper.core.StandardTable
Insert - Record Class in pro.verron.officestamper.api: The Insert record represents a container for managing collections of document elements that can be inserted into a DOCX document.
Insert(Object) - Constructor for record class pro.verron.officestamper.api.Insert: Creates an Insert with a single element.
Insert(List) - Constructor for record class pro.verron.officestamper.api.Insert: Compact constructor for Insert.
Invoker - Record Class in pro.verron.officestamper.core: Represents an invoker that encapsulates the name, arguments, and executor of a method to be invoked.
Invoker(Object, Method) - Constructor for record class pro.verron.officestamper.core.Invoker: Constructs an Invoker instance by extracting the method name, parameter types, and creating a corresponding ReflectionExecutor for the provided object and method.
Invoker(String, List, MethodExecutor) - Constructor for record class pro.verron.officestamper.core.Invoker: Constructs an Invoker instance using the provided method name, argument types, and executor.
Invoker(String, Invokers.Args, MethodExecutor) - Constructor for record class pro.verron.officestamper.core.Invoker: Creates an instance of a Invoker record class.
invokers() - Method in class pro.verron.officestamper.core.UnionEvaluationContext: Returns the invokers.
Invokers - Class in pro.verron.officestamper.core: The Invokers class serves as an implementation of the MethodResolver interface.
Invokers(Stream) - Constructor for class pro.verron.officestamper.core.Invokers: Constructs an Invokers instance, grouping and mapping invokers by their names and argument types to their corresponding executors.
Invokers.Args - Record Class in pro.verron.officestamper.core: Represents argument types associated with method invocation.
isoDate() - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves LocalDate values to a formatted string using the DateTimeFormatter.ISO_LOCAL_DATE pattern.
isoDate(DateTimeFormatter) - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves LocalDate values to a formatted string using the given DateTimeFormatter pattern.
isoDateTime() - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves LocalDateTime values to a formatted string using the DateTimeFormatter.ISO_LOCAL_DATE_TIME pattern.
isoDateTime(DateTimeFormatter) - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves LocalDateTime values to a formatted string using the given DateTimeFormatter pattern.
isoTime() - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves LocalTime values to a formatted string using the DateTimeFormatter.ISO_LOCAL_TIME pattern.
isoTime(DateTimeFormatter) - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves LocalTime values to a formatted string using the given DateTimeFormatter pattern.
isPotentialHook(Object) - Static method in interface pro.verron.officestamper.core.DocxHook: Checks if the given object is a potential hook.
isTouchedByRange(int, int) - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Checks if the given range of indices touches the start or end index of the run.
isType(CTSmartTagRun, String, String) - Static method in interface pro.verron.officestamper.core.DocxHook: Checks if the given tag is of the specified type.

L

legacyDate() - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves Date values to a formatted string using the "dd.MM.yyyy" pattern.
legacyDate(DateTimeFormatter) - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves Date values to a formatted string using the given DateTimeFormatter pattern.
list() - Method in class pro.verron.officestamper.core.ContextBranch: Returns the list of objects in the branch, in reverse order.
listIterator(int) - Method in class pro.verron.officestamper.preset.StampTable
lookupVariable(String) - Method in class pro.verron.officestamper.core.UnionEvaluationContext

M

MapAccessor - Class in pro.verron.officestamper.preset: MapAccessor is an implementation of the PropertyAccessor interface, designed for accessing and manipulating properties specifically on Map objects.
MapAccessor() - Constructor for class pro.verron.officestamper.preset.MapAccessor: Constructs a new instance of MapAccessor.
match(String) - Method in record class pro.verron.officestamper.core.Matcher: Checks if the given expression matches the specified criteria.
matcher() - Method in record class pro.verron.officestamper.experimental.PlaceholderFinder: Returns the value of the matcher record component.
matcher() - Method in record class pro.verron.officestamper.experimental.StandardPlaceholder: Returns the value of the matcher record component.
Matcher - Record Class in pro.verron.officestamper.core: The Matcher class provides methods to match and strip expressions based on a specified prefix and suffix.
Matcher(String, String) - Constructor for record class pro.verron.officestamper.core.Matcher: Creates an instance of a Matcher record class.
mergeSimilarRuns() - Static method in class pro.verron.officestamper.preset.Preprocessors: Returns a PreProcessor object that merges same style runs that are next to each other in a WordprocessingMLPackage document.
method() - Method in record class pro.verron.officestamper.core.ReflectionExecutor: Returns the value of the method record component.
minimal() - Static method in class pro.verron.officestamper.preset.OfficeStamperConfigurations: Creates a minimal OfficeStamperConfiguration instance with essential settings to provide basic placeholder processing and fallback resolvers.

N

name() - Method in record class pro.verron.officestamper.api.CustomFunction: Returns the value of the name record component.
name() - Method in record class pro.verron.officestamper.core.Invoker: Returns the value of the name record component.
newCommentHook(DocxPart, CTSmartTagRun) - Static method in interface pro.verron.officestamper.core.DocxHook: Creates a new comment hook.
newRun(DocxPart) - Method in class pro.verron.officestamper.preset.Image: Creates a new run with the provided image and associated metadata.
noopFactory() - Static method in class pro.verron.officestamper.preset.EvaluationContextFactories: Returns an EvaluationContextFactory instance that does no customization.
nullToDefault(String) - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves null values by creating a run with a default text value.
nullToEmpty() - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that replaces null values with an empty string.
nullToPlaceholder() - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves null values by not replacing their expression.
nullToPlaceholder(String) - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves null values by not replacing their expression.

O

object() - Method in record class pro.verron.officestamper.core.ReflectionExecutor: Returns the value of the object record component.
ObjectResolver - Interface in pro.verron.officestamper.api: The ObjectResolver interface provides a contract for resolving objects to create a run with the resolved content.
ObjectResolverRegistry - Class in pro.verron.officestamper.core: A registry for object resolvers.
ObjectResolverRegistry(List) - Constructor for class pro.verron.officestamper.core.ObjectResolverRegistry: A registry for object resolvers.
of(DocxPart, CTSmartTagRun) - Static method in record class pro.verron.officestamper.core.Tag: Creates a new Tag instance using the provided DocxPart and CTSmartTagRun.
ofCustomFunction(CustomFunction) - Static method in class pro.verron.officestamper.core.Invokers: Creates an Invoker for a custom function.
OfficeStamper<T> - Interface in pro.verron.officestamper.api: This is an interface that defines the contract for stamping templates with context and returning the result as a document.
OfficeStamperConfiguration - Interface in pro.verron.officestamper.api: Interface representing the configuration for the Office Stamper functionality.
OfficeStamperConfigurations - Class in pro.verron.officestamper.preset: Utility class providing factory methods for various pre-configured instances of OfficeStamperConfiguration.
OfficeStamperEvaluationContextFactory - Class in pro.verron.officestamper.core: Factory for creating EvaluationContext instances for OfficeStamper.
OfficeStamperException - Exception Class in pro.verron.officestamper.api: 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.
OfficeStamperException() - Constructor for exception class pro.verron.officestamper.api.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.
OfficeStamperException(String) - Constructor for exception class pro.verron.officestamper.api.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.
OfficeStamperException(String, Throwable) - Constructor for exception class pro.verron.officestamper.api.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.
OfficeStamperException(Throwable) - Constructor for exception class pro.verron.officestamper.api.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.
OfficeStampers - Class in pro.verron.officestamper.preset: OfficeStampers is a utility class that provides factory methods for creating document stampers for Office documents.
ofHooks(ContentAccessor) - Static method in class pro.verron.officestamper.api.Hooks: Creates a ResetableIterator of Hook instances for a specific document part, based on the provided content accessor.
ofHooks(ContentAccessor, DocxPart) - Static method in interface pro.verron.officestamper.core.DocxHook: Creates an iterator over the hooks in the given content accessor.

P

paragraph() - Method in class pro.verron.officestamper.api.CommentProcessor: Returns the paragraph associated with this processor.
paragraph() - Method in class pro.verron.officestamper.api.ProcessorContext: Returns the paragraph currently being processed.
Paragraph - Interface in pro.verron.officestamper.api: The Paragraph interface represents a paragraph in a text document.
ParagraphCollector(Pattern) - Constructor for class pro.verron.officestamper.api.PlaceholderHooker.ParagraphCollector: Constructs a new PlaceholderHooker.ParagraphCollector with the specified pattern.
paragraphs() - Method in class pro.verron.officestamper.api.PlaceholderHooker.ParagraphCollector: Returns the list of collected paragraphs that matched the pattern.
parameterTypes() - Method in record class pro.verron.officestamper.api.CustomFunction: Returns the value of the parameterTypes record component.
parent(Class) - Method in interface pro.verron.officestamper.api.Paragraph: Retrieves the parent of the current paragraph that matches the specified class type.
parent(Class) - Method in class pro.verron.officestamper.core.StandardParagraph: Retrieves the nearest parent of the specified type for the current paragraph.
parent(Class) - Method in class pro.verron.officestamper.experimental.PowerpointParagraph
parentTable() - Method in interface pro.verron.officestamper.api.Paragraph: Retrieves the parent table of the current paragraph, if it exists.
parentTable() - Method in class pro.verron.officestamper.core.StandardParagraph
parentTable() - Method in class pro.verron.officestamper.experimental.PowerpointParagraph
parentTableRow() - Method in interface pro.verron.officestamper.api.Paragraph: Retrieves the parent table row of the current paragraph, if it exists.
parentTableRow() - Method in class pro.verron.officestamper.core.StandardParagraph
parentTableRow() - Method in class pro.verron.officestamper.experimental.PowerpointParagraph
part() - Method in interface pro.verron.officestamper.api.DocxPart: Retrieves the part of the WordprocessingML-based document.
part() - Method in class pro.verron.officestamper.api.ProcessorContext: Returns the document part currently being processed.
part() - Method in class pro.verron.officestamper.core.TextualDocxPart: Retrieves the part associated with this instance of the document part.
passing() - Static method in class pro.verron.officestamper.preset.ExceptionResolvers: The passing resolver will handle exceptions by returning the placeholder expression.
pattern() - Method in record class pro.verron.officestamper.experimental.PlaceholderFinder: Returns the value of the pattern record component.
Placeholder - Interface in pro.verron.officestamper.experimental: The Placeholder interface represents a placeholder in a text document.
PlaceholderFinder - Record Class in pro.verron.officestamper.experimental: The ExpressionFinder class is responsible for finding expressions in a given text based on a specified pattern and matcher.
PlaceholderFinder(Pattern, Matcher) - Constructor for record class pro.verron.officestamper.experimental.PlaceholderFinder: Creates an instance of a PlaceholderFinder record class.
PlaceholderHooker - Class in pro.verron.officestamper.api: The PlaceholderHooker class is a pre-processor that prepares inline placeholders in a WordprocessingML document.
PlaceholderHooker(String, String) - Constructor for class pro.verron.officestamper.api.PlaceholderHooker: Constructs a new PlaceholderHooker instance with the specified regular expression and XML element name.
PlaceholderHooker(Pattern, String) - Constructor for class pro.verron.officestamper.api.PlaceholderHooker: Constructs a new PlaceholderHooker instance with the specified pattern and XML element name.
PlaceholderHooker.ParagraphCollector - Class in pro.verron.officestamper.api: A TraversalUtilVisitor implementation that collects paragraphs matching a given pattern.
Placeholders - Class in pro.verron.officestamper.experimental: The Expressions class provides utility methods for finding variables and processors in a given text.
PostProcessor - Interface in pro.verron.officestamper.api: The PostProcessor interface defines a contract for performing transformations or manipulations on instances of WordprocessingMLPackage.
Postprocessors - Class in pro.verron.officestamper.preset: The Postprocessors class provides static utility methods for obtaining implementations of the PostProcessor interface that perform specific post-processing operations on WordprocessingMLPackage documents.
PowerpointCollector<T> - Class in pro.verron.officestamper.experimental: The PowerpointCollector class is used to collect instances of a specific class in a PowerPoint presentation.
PowerpointCollector(Class) - Constructor for class pro.verron.officestamper.experimental.PowerpointCollector: The PowerpointCollector class is used to collect instances of a specific class in a PowerPoint presentation.
PowerpointParagraph - Class in pro.verron.officestamper.experimental: A "Run" defines a region of text within a docx document with a common set of properties.
PowerpointParagraph(PptxPart, CTTextParagraph) - Constructor for class pro.verron.officestamper.experimental.PowerpointParagraph: Constructs a new ParagraphWrapper for the given paragraph.
PowerpointRun - Record Class in pro.verron.officestamper.experimental: A record that represents a run of text in a PowerPoint slide.
PowerpointRun(int, int, int, CTRegularTextRun) - Constructor for record class pro.verron.officestamper.experimental.PowerpointRun: Creates an instance of a PowerpointRun record class.
PowerpointStamper - Class in pro.verron.officestamper.experimental: The PowerpointStamper class implements the OfficeStamper interface to provide capability for stamping PowerPoint presentations with context and writing the result to an OutputStream.
PowerpointStamper() - Constructor for class pro.verron.officestamper.experimental.PowerpointStamper: Constructs a new instance of the PowerpointStamper class.
pptxPackageStamper() - Static method in class pro.verron.officestamper.experimental.ExperimentalStampers: Returns a new instance of the OfficeStamper implementation for stamping PowerPoint presentations with context and writing the result to an OutputStream.
PptxPart - Record Class in pro.verron.officestamper.experimental: The PptxPart class represents a specific implementation of the DocxPart interface designed for handling parts within a PowerPoint document.
PptxPart(PresentationMLPackage) - Constructor for record class pro.verron.officestamper.experimental.PptxPart: Creates an instance of a PptxPart record class.
pptxStamper() - Static method in class pro.verron.officestamper.experimental.ExperimentalStampers: Returns a new instance of the StreamStamper implementation for stamping PowerPoint presentations with context and writing the result to an OutputStream.
prefix() - Method in record class pro.verron.officestamper.core.Matcher: Returns the value of the prefix record component.
prepareCommentProcessor() - Static method in class pro.verron.officestamper.preset.Preprocessors: Returns a PreProcessor object that prepares comment processors for use with the stamper.
preparePlaceholders(String, String) - Static method in class pro.verron.officestamper.preset.Preprocessors: Returns a PreProcessor object that prepares inline placeholders based on the provided regex and element name.
PreProcessor - Interface in pro.verron.officestamper.api: The PreProcessor interface defines a method for processing a WordprocessingMLPackage document prior to executing specific operations.
Preprocessors - Class in pro.verron.officestamper.preset: A helper class that provides pre-processing functionality for WordprocessingMLPackage documents.
pro.verron.officestamper - module pro.verron.officestamper: The module descriptor for the pro.verron.officestamper module.
pro.verron.officestamper.api - package pro.verron.officestamper.api: Defines the core API for the library.
pro.verron.officestamper.core - package pro.verron.officestamper.core: Provides the core functionality for the OfficeStamper library.
pro.verron.officestamper.experimental - package pro.verron.officestamper.experimental: This package contains experimental implementations of the OfficeStamper API.
pro.verron.officestamper.preset - package pro.verron.officestamper.preset: This package contains the preset configurations and utilities for OfficeStamper.
process(WordprocessingMLPackage) - Method in class pro.verron.officestamper.api.CommentHooker
process(WordprocessingMLPackage) - Method in class pro.verron.officestamper.api.HookRemover
process(WordprocessingMLPackage) - Method in class pro.verron.officestamper.api.PlaceholderHooker
process(WordprocessingMLPackage) - Method in interface pro.verron.officestamper.api.PostProcessor: Processes a given WordprocessingMLPackage document.
process(WordprocessingMLPackage) - Method in interface pro.verron.officestamper.api.PreProcessor: Processes the provided WordprocessingMLPackage document based on implementation-specific behavior.
process(EvaluationContext) - Method in class pro.verron.officestamper.core.Engine: Processes the provided evaluation context against the expression defined in the processor context.
ProcessorContext - Class in pro.verron.officestamper.api: Represents a context within a document processing operation.
ProcessorContext(DocxPart, Paragraph, Comment, String, ContextTree) - Constructor for class pro.verron.officestamper.api.ProcessorContext: Constructs a ProcessorContext.

R

raw() - Static method in class pro.verron.officestamper.preset.OfficeStamperConfigurations: Creates a OfficeStamperConfiguration instance without any configuration or resolvers, processors, preprocessors or postprocessors applied.
raw(String) - Static method in class pro.verron.officestamper.experimental.Placeholders: Creates a new raw placeholder with the given text.
read(EvaluationContext, Object, String) - Method in class pro.verron.officestamper.preset.MapAccessor
ReflectionExecutor - Record Class in pro.verron.officestamper.core: A record encapsulating an object and a method, and providing functionality to execute the method on the given object using reflection.
ReflectionExecutor(Object, Method) - Constructor for record class pro.verron.officestamper.core.ReflectionExecutor: Creates an instance of a ReflectionExecutor record class.
remove() - Method in interface pro.verron.officestamper.api.Paragraph: Removes the paragraph from the document.
remove() - Method in interface pro.verron.officestamper.api.Table: Removes the entire table from the document.
remove() - Method in interface pro.verron.officestamper.api.Table.Row: Removes the entire row from the table.
remove() - Method in class pro.verron.officestamper.core.StandardParagraph: Removes the paragraph represented by the current instance.
remove() - Method in class pro.verron.officestamper.core.StandardRow
remove() - Method in class pro.verron.officestamper.core.StandardTable
remove() - Method in record class pro.verron.officestamper.core.Tag: Removes the current tag from its parent's content list.
remove() - Method in class pro.verron.officestamper.experimental.PowerpointParagraph
removeComment(Comment) - Method in interface pro.verron.officestamper.api.Table.Row: Removes a comment from this row.
removeComment(Comment) - Method in class pro.verron.officestamper.core.StandardRow
removeLanguageInfo() - Static method in class pro.verron.officestamper.preset.Preprocessors: Returns a PreProcessor object that removes all language informations such as grammatical and orthographics markers in a WordprocessingMLPackage document.
removeLanguageProof() - Static method in class pro.verron.officestamper.preset.Preprocessors: Returns a PreProcessor object that removes all ProofErr elements from the WordprocessingMLPackage document.
removeMalformedComments() - Static method in class pro.verron.officestamper.preset.Preprocessors: Returns a PreProcessor object that removes comments information that is not conforming to the expected patterns.
removeOrphanedEndnotes() - Static method in class pro.verron.officestamper.preset.Postprocessors: Creates a PostProcessor that removes orphaned endnotes from a WordprocessingMLPackage document.
removeOrphanedFootnotes() - Static method in class pro.verron.officestamper.preset.Postprocessors: Creates a PostProcessor that removes orphaned footnotes from a WordprocessingMLPackage document.
removeTags(String) - Static method in class pro.verron.officestamper.preset.Postprocessors: Creates a PostProcessor that removes specified XML elements from a WordprocessingMLPackage document.
repeat(Iterable) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IRepeatProcessor: Mark content to be copied once for each element in the passed-in iterable.
repeatDocPart(Iterable) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IRepeatDocPartProcessor: Mark a document part to be copied once for each element in the passed-in iterable.
repeatParagraph(Iterable) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IParagraphRepeatProcessor: Mark a paragraph to be copied once for each element in the passed-in iterable.
repeatTableRow(Iterable) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IRepeatRowProcessor: Mark a table row to be copied once for each element in the passed-in iterable.
replace(int, int, String) - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Replaces a substring within the run's text.
replace(Object, Object, Insert) - Method in interface pro.verron.officestamper.api.Paragraph: Replaces a section of elements within the document, defined by the start and end objects, with the elements provided by the given insert.
replace(Object, Object, Insert) - Method in class pro.verron.officestamper.core.StandardParagraph
replace(Object, Object, Insert) - Method in class pro.verron.officestamper.experimental.PowerpointParagraph
replace(String, String) - Method in class pro.verron.officestamper.experimental.ExcelParagraph: Replaces the given expression with the replacement object within the paragraph.
replace(String, Insert) - Method in interface pro.verron.officestamper.api.Paragraph: Replaces a specified placeholder within the paragraph with the provided insert.
replace(String, Insert) - Method in class pro.verron.officestamper.core.StandardParagraph
replace(String, Insert) - Method in class pro.verron.officestamper.experimental.PowerpointParagraph: Replaces a placeholder within the paragraph with the content from the given insert, preserving formatting.
replace(List, List) - Method in interface pro.verron.officestamper.api.Paragraph: Replaces specified contiguous elements within the paragraph with new elements.
replace(List, List) - Method in class pro.verron.officestamper.core.StandardParagraph: Replaces a set of paragraph elements with new ones within the current paragraph's siblings.
replace(List, List) - Method in class pro.verron.officestamper.experimental.PowerpointParagraph
replace(Insert) - Method in record class pro.verron.officestamper.core.Tag: Replaces the current tag with the provided Insert object in the parent's content list.
replaceWith(String) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IReplaceWithProcessor: Replaces content with the specified expression.Works only in a single paragraph.
resetCommentProcessors() - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Resets all processors in the configuration.
resetResolvers() - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Resets all resolvers in the configuration.
resolve(String, String, Exception) - Method in interface pro.verron.officestamper.api.ExceptionResolver: Resolves the given expression by providing a result or handling an exception that occurred during placeholder processing within a document.
resolve(EvaluationContext) - Method in class pro.verron.officestamper.core.Engine: Resolves an Insert object by processing the provided evaluation context using the current processor context.
resolve(EvaluationContext, Object, String, List) - Method in class pro.verron.officestamper.core.Invokers: Resolves a method executor for a given method name and argument types within the specified context and target object.
resolve(DocxPart, String, Object) - Method in interface pro.verron.officestamper.api.ObjectResolver: Resolves the expression in the given document with the provided object.
resolve(DocxPart, String, Object) - Method in class pro.verron.officestamper.api.StringResolver: Resolves an object to a string and creates a new run with the resolved string as content.
resolve(DocxPart, String, Object) - Method in class pro.verron.officestamper.core.ObjectResolverRegistry: Resolves the expression in the given document with the provided object.
resolve(T) - Method in class pro.verron.officestamper.api.StringResolver: Resolves an object to a string.
Resolvers - Class in pro.verron.officestamper.preset: This class provides static methods to create different types of ObjectResolver.
resolveTable(StampTable) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.ITableResolver: Resolves the given table by manipulating the given table in the template.
root() - Method in class pro.verron.officestamper.core.ContextBranch: Returns the root object of the branch.
run() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Returns the value of the run record component.
run(EngineFactory, ContextRoot, OfficeStamperEvaluationContextFactory) - Method in class pro.verron.officestamper.core.CommentHook
run(EngineFactory, ContextRoot, OfficeStamperEvaluationContextFactory) - Method in interface pro.verron.officestamper.core.DocxHook: Executes the hook's logic within the context of a document processing flow.
run(EngineFactory, ContextRoot, OfficeStamperEvaluationContextFactory) - Method in class pro.verron.officestamper.core.TagHook

S

setContextKey(String) - Method in interface pro.verron.officestamper.api.Hook: Sets the context key associated with this hook.
setContextKey(String) - Method in class pro.verron.officestamper.core.CommentHook
setContextKey(String) - Method in class pro.verron.officestamper.core.TagHook
setEvaluationContextFactory(EvaluationContextFactory) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Sets the EvaluationContextFactory for creating Spring Expression Language (SpEL) EvaluationContext instances.
setEvaluationContextFactory(EvaluationContextFactory) - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Sets the EvaluationContextFactory which creates Spring EvaluationContext instances used for evaluating expressions in comments and text.
setExceptionResolver(ExceptionResolver) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Sets the exception resolver to be used by the OfficeStamperConfiguration.
setExceptionResolver(ExceptionResolver) - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Configures the exception resolver for the DocxStamperConfiguration.
setExpressionParser(ExpressionParser) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Sets the expression parser to be used by the office stamper.
setExpressionParser(ExpressionParser) - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Sets the expression parser used for expression evaluation.
setResolvers(List) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Sets the list of object resolvers for the OfficeStamper configuration.
setResolvers(List) - Method in class pro.verron.officestamper.core.DocxStamperConfiguration: Sets resolvers for resolving objects in the DocxStamperConfiguration.
setRPr(RPr) - Method in record class pro.verron.officestamper.api.Insert: Sets the run properties for all runs in the list.
setVariable(String, Object) - Method in class pro.verron.officestamper.core.UnionEvaluationContext
size() - Method in class pro.verron.officestamper.preset.StampTable
sourceTypes() - Method in record class pro.verron.officestamper.core.Invokers.Args: Returns the value of the sourceTypes record component.
stamp(InputStream, Object, OutputStream) - Method in class pro.verron.officestamper.api.StreamStamper: Stamps the template present in the given InputStream with the context given and writes the result to the provided OutputStream.
stamp(PresentationMLPackage, Object) - Method in class pro.verron.officestamper.experimental.PowerpointStamper
stamp(SpreadsheetMLPackage, Object) - Method in class pro.verron.officestamper.experimental.ExcelStamper
stamp(WordprocessingMLPackage, Object) - Method in class pro.verron.officestamper.core.DocxStamper: Reads in a .docx template and "stamps" it, using the specified context object to fill out any expressions it finds.
stamp(T, Object) - Method in interface pro.verron.officestamper.api.OfficeStamper: Stamps the given template with the given context and returns the resulting document.
StampTable - Class in pro.verron.officestamper.preset: Represents a table with several columns, a header line, and several lines of content
StampTable() - Constructor for class pro.verron.officestamper.preset.StampTable: Instantiate an empty table
StampTable(List, List) - Constructor for class pro.verron.officestamper.preset.StampTable: Instantiate a table with headers and several lines
standard() - Static method in class pro.verron.officestamper.preset.OfficeStamperConfigurations: Creates a standard OfficeStamperConfiguration instance with predefined settings.
standard(ObjectResolver) - Static method in class pro.verron.officestamper.preset.OfficeStamperConfigurations: Creates a standard OfficeStamperConfiguration instance with a set of predefined comment processors, resolvers, and preprocessors.
StandardComment - Class in pro.verron.officestamper.core: Standard implementation of the Comment interface.
StandardComment(DocxPart, CTSmartTagRun, CommentRangeStart, CommentRangeEnd, Comments.Comment, R.CommentReference) - Constructor for class pro.verron.officestamper.core.StandardComment: Constructs a new StandardComment object.
StandardParagraph - Class in pro.verron.officestamper.core: Represents a wrapper for managing and manipulating DOCX paragraph elements.
StandardPlaceholder - Record Class in pro.verron.officestamper.experimental: The StandardPlaceholder class represents a placeholder with a specific matching condition and associated expression.
StandardPlaceholder(Matcher, String) - Constructor for record class pro.verron.officestamper.experimental.StandardPlaceholder: Creates an instance of a StandardPlaceholder record class.
StandardRow - Class in pro.verron.officestamper.core: Represents a standard row in a table.
StandardRow(DocxPart, Tbl, Tr) - Constructor for class pro.verron.officestamper.core.StandardRow: Constructs a new StandardRow with the specified table row element.
StandardTable - Class in pro.verron.officestamper.core: The StandardTable class represents a table in a document and implements the Table interface.
StandardTable(Tbl) - Constructor for class pro.verron.officestamper.core.StandardTable: Constructs a new StandardTable object with the specified Tbl object.
startIndex() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Returns the value of the startIndex record component.
streamInvokersFromClass(Map) - Static method in class pro.verron.officestamper.core.Invokers: Transforms a map containing interface-to-implementation mappings into a stream of Invoker objects.
StreamStamper<T> - Class in pro.verron.officestamper.api: This class implements the functionality of an OfficeStamper meant for dealing with streams of data.
StreamStamper(Function, OfficeStamper, BiConsumer) - Constructor for class pro.verron.officestamper.api.StreamStamper: Constructs a new StreamStamper with the provided loader, stamper and exporter.
StringResolver<T> - Class in pro.verron.officestamper.api: This is an abstract class that provides a generic implementation for resolving objects to strings.
StringResolver(Class) - Constructor for class pro.verron.officestamper.api.StringResolver: Creates a new StringResolver with the given type.
strip(String) - Method in record class pro.verron.officestamper.core.Matcher: Strips the prefix and suffix from the given expression and returns the inner part.
suffix() - Method in record class pro.verron.officestamper.core.Matcher: Returns the value of the suffix record component.

T

table() - Method in class pro.verron.officestamper.api.ProcessorContext: Returns the table containing the current paragraph, if any.
table() - Method in interface pro.verron.officestamper.api.Table.Row: Returns the table that this row belongs to.
table() - Method in class pro.verron.officestamper.core.StandardRow
Table - Interface in pro.verron.officestamper.api: Represents a table in a document that can be manipulated by the office stamper.
Table.Row - Interface in pro.verron.officestamper.api: Represents a row within a table that can be manipulated by the office stamper.
tableRow() - Method in class pro.verron.officestamper.api.ProcessorContext: Returns the table row containing the current paragraph, if any.
tag() - Method in record class pro.verron.officestamper.core.Tag: Returns the value of the tag record component.
Tag - Record Class in pro.verron.officestamper.core: Represents a Tag entity consisting of a DocxPart and a CTSmartTagRun.
Tag(DocxPart, CTSmartTagRun) - Constructor for record class pro.verron.officestamper.core.Tag: Creates an instance of a Tag record class.
TagHook - Class in pro.verron.officestamper.core: Hook for processing tags.
TextualDocxPart - Class in pro.verron.officestamper.core: Represents a textual part of a DOCX document, encapsulating the content and structure of the part while enabling various operations such as accessing paragraphs, runs, and related parts.
TextualDocxPart(WordprocessingMLPackage) - Constructor for class pro.verron.officestamper.core.TextualDocxPart: Constructs a TextualDocxPart using the provided document.
TextualDocxPart(WordprocessingMLPackage, Part, ContentAccessor) - Constructor for class pro.verron.officestamper.core.TextualDocxPart: Constructs a TextualDocxPart using the specified document, part, and contentAccessor.
throwing() - Static method in class pro.verron.officestamper.preset.ExceptionResolvers: The throwing resolver will handle exceptions by immediately throwing an OfficeStamperException.
throwing(String) - Static method in exception class pro.verron.officestamper.api.OfficeStamperException: Creates a supplier that returns a new instance of OfficeStamperException with the specified message.
throwing(ThrowingFunction) - Static method in exception class pro.verron.officestamper.api.OfficeStamperException: Wraps a ThrowingFunction into a standard Java Function, converting any checked exceptions thrown by the original function into an OfficeStamperException.
toString() - Method in record class pro.verron.officestamper.api.CustomFunction: Returns a string representation of this record class.
toString() - Method in record class pro.verron.officestamper.api.Insert: Returns a string representation of this record class.
toString() - Method in class pro.verron.officestamper.core.ContextBranch
toString() - Method in record class pro.verron.officestamper.core.Invoker: Returns a string representation of this record class.
toString() - Method in record class pro.verron.officestamper.core.Invokers.Args: Returns a string representation of this record class.
toString() - Method in record class pro.verron.officestamper.core.Matcher: Returns a string representation of this record class.
toString() - Method in record class pro.verron.officestamper.core.ReflectionExecutor: Returns a string representation of this record class.
toString() - Method in class pro.verron.officestamper.core.StandardComment: Generates a string representation of the StandardComment object, including its ID, content, and the amount children comment.
toString() - Method in class pro.verron.officestamper.core.StandardParagraph: Returns the string representation of the paragraph.
toString() - Method in record class pro.verron.officestamper.core.Tag: Returns a string representation of this record class.
toString() - Method in class pro.verron.officestamper.core.UnionEvaluationContext
toString() - Method in class pro.verron.officestamper.experimental.ExcelParagraph
toString() - Method in record class pro.verron.officestamper.experimental.PlaceholderFinder: Returns a string representation of this record class.
toString() - Method in class pro.verron.officestamper.experimental.PowerpointParagraph
toString() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Returns a string representation of this record class.
toString() - Method in record class pro.verron.officestamper.experimental.PptxPart: Returns a string representation of this record class.
toString() - Method in record class pro.verron.officestamper.experimental.StandardPlaceholder: Returns a string representation of this object.
type() - Method in record class pro.verron.officestamper.core.Tag: Retrieves the type of the tag.

U

UnionEvaluationContext - Class in pro.verron.officestamper.core: An EvaluationContext that combines multiple contexts.

V

validate(List) - Method in record class pro.verron.officestamper.core.Invokers.Args: Validates if the provided list of classes matches the source types according to the compatibility rules.
visit(Object) - Method in class pro.verron.officestamper.experimental.ExcelCollector: Visits the given object and performs specific operations based on its type.
visit(Object) - Method in class pro.verron.officestamper.experimental.PowerpointCollector: Signal the visited object through the before method, then apply logic to know the visit next elements or ignore deeper nesting based on the object type.

W

withImplementation(BiFunction) - Method in interface pro.verron.officestamper.api.CustomFunction.NeedsBiFunctionImpl: Registers or sets a BiFunction implementation to be used by the client.
withImplementation(Function) - Method in interface pro.verron.officestamper.api.CustomFunction.NeedsFunctionImpl: Sets a function implementation that operates on a specific input type and produces a result.
withImplementation(TriFunction) - Method in interface pro.verron.officestamper.api.CustomFunction.NeedsTriFunctionImpl: Registers the implementation of a TriFunction that accepts three input arguments of types T, U, and V and produces a result.
write(EvaluationContext, Object, String, Object) - Method in class pro.verron.officestamper.preset.MapAccessor

X

xlsxPackageStamper() - Static method in class pro.verron.officestamper.experimental.ExperimentalStampers: Returns a new instance of the OfficeStamper implementation for stamping Excel templates with context and writing the result to an OutputStream.

A B C D E F G H I L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Serialized Form