Index (OfficeStamper engine 2.6.0 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

AbstractCommentProcessor - Class in pro.verron.officestamper.api: AbstractCommentProcessor is an abstract base class for comment processors.
AbstractCommentProcessor(ParagraphPlaceholderReplacer) - Constructor for class pro.verron.officestamper.api.AbstractCommentProcessor: Creates an instance of AbstractCommentProcessor with the given ParagraphPlaceholderReplacer.
addCommentProcessor(Class<?>, Function<ParagraphPlaceholderReplacer, CommentProcessor>) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Adds a comment processor to the OfficeStamperConfiguration.
addCustomFunction(String, Class<T>) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration
addCustomFunction(String, Class<T>, Class) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration
addCustomFunction(String, Class<T>, Class, Class<V>) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration
addCustomFunction(String, Supplier<?>) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration
addPreprocessor(PreProcessor) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Adds a pre-processor to the OfficeStamperConfiguration.
addResolver(ObjectResolver) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Adds an ObjectResolver to the OfficeStamperConfiguration.
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.experimental.PowerpointParagraph
apply(T, U, V) - Method in interface pro.verron.officestamper.utils.TriFunction
asPlaceholder() - Method in interface pro.verron.officestamper.api.Comment: Converts the comment to a Placeholder representation.
asString() - Method in interface pro.verron.officestamper.api.Paragraph: Returns the paragraph as a string.
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.

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

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.
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<T>) - Static method in class pro.verron.officestamper.experimental.ExcelCollector: Collects objects of a specific type from an Excel file.
collect(Object, Class<T>) - Static method in class pro.verron.officestamper.experimental.PowerpointCollector: Collects instances of a specific class in a PowerPoint presentation.
comment() - Method in record class pro.verron.officestamper.api.ProcessorContext: Returns the value of the comment record component.
comment() - Method in record class pro.verron.officestamper.preset.Paragraphs: Returns the value of the comment record component.
Comment - Interface in pro.verron.officestamper.api: The Comment interface provides methods for managing comments in a document.
CommentProcessor - Interface in pro.verron.officestamper.api: CommentProcessor is an interface that defines the methods for processing comments in a .docx template.
CommentProcessorFactory - Class in pro.verron.officestamper.preset
CommentProcessorFactory(OfficeStamperConfiguration) - Constructor for class pro.verron.officestamper.preset.CommentProcessorFactory
CommentProcessorFactory.IDisplayIfProcessor - Interface in pro.verron.officestamper.preset
CommentProcessorFactory.IParagraphRepeatProcessor - Interface in pro.verron.officestamper.preset
CommentProcessorFactory.IRepeatDocPartProcessor - Interface in pro.verron.officestamper.preset
CommentProcessorFactory.IRepeatProcessor - Interface in pro.verron.officestamper.preset
CommentProcessorFactory.IReplaceWithProcessor - Interface in pro.verron.officestamper.preset
CommentProcessorFactory.ITableResolver - Interface in pro.verron.officestamper.preset
commitChanges(WordprocessingMLPackage) - Method in interface pro.verron.officestamper.api.CommentProcessor: Deprecated, for removal: This API element is subject to removal in a future version.
replaced by CommentProcessor.commitChanges(DocxPart)
commitChanges(DocxPart) - Method in interface pro.verron.officestamper.api.CommentProcessor: This method is called after all comments in the .docx template have been passed to the comment processor.
configureEvaluationContext(StandardEvaluationContext) - Method in interface pro.verron.officestamper.api.EvaluationContextConfigurer: Configure the context before it's used by docxstamper.
contains(String) - Method in interface pro.verron.officestamper.api.Paragraph: Deprecated, for removal: This API element is subject to removal in a future version.
was used by the core to deal with multiline paragraphs
content() - Method in interface pro.verron.officestamper.api.DocxPart
content() - Method in interface pro.verron.officestamper.api.Placeholder: Returns the content of the placeholder.
content() - Method in class pro.verron.officestamper.experimental.PptxPart
CustomFunction - Record Class in pro.verron.officestamper.api
CustomFunction(String, List<Class<?>>, Function<List<Object>, Object>) - 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
CustomFunction.NeedsFunctionImpl<T> - Interface in pro.verron.officestamper.api
CustomFunction.NeedsTriFunctionImpl<T,U,V> - Interface in pro.verron.officestamper.api
customFunctions() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration

D

data() - Method in record class pro.verron.officestamper.preset.Paragraphs: Returns the value of the data record component.
defaultConfigurer() - Static method in class pro.verron.officestamper.preset.EvaluationContextConfigurers: Returns a default EvaluationContextConfigurer 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.
displayDocPartIf(Boolean) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor
displayDocPartIfPresent(Object) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor
displayIf(ParagraphPlaceholderReplacer) - Method in class pro.verron.officestamper.preset.CommentProcessorFactory
displayParagraphIf(Boolean) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor
displayParagraphIfPresent(Object) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor
displayTableIf(Boolean) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor
displayTableIfPresent(Object) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor
displayTableRowIf(Boolean) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor
displayTableRowIfPresent(Object) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor
displayWordsIf(Boolean) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor
displayWordsIfPresent(Object) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor
document() - Method in interface pro.verron.officestamper.api.DocxDocument
document() - Method in class pro.verron.officestamper.experimental.PptxPart
DocxDocument - Interface in pro.verron.officestamper.api
DocxPart - Interface in pro.verron.officestamper.api
docxStamper() - Static method in class pro.verron.officestamper.preset.OfficeStampers: Creates a new DocxStamper with the default configuration.
docxStamper(OfficeStamperConfiguration) - Static method in class pro.verron.officestamper.preset.OfficeStampers: Creates a new instance of the DocxStamper class with the specified OfficeStamperConfiguration.

E

elements() - Method in record class pro.verron.officestamper.preset.Paragraphs: Returns the value of the elements record component.
elements(Class<T>) - Method in record class pro.verron.officestamper.preset.Paragraphs
empty() - Static method in class pro.verron.officestamper.preset.StampTable: empty.
endIndex() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Returns the value of the endIndex record component.
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.ProcessorContext: 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.preset.Paragraphs: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class pro.verron.officestamper.preset.StampTable
EvaluationContextConfigurer - Interface in pro.verron.officestamper.api: The EvaluationContextConfigurer interface allows for custom configuration of a Spring Expression Language (SPEL) EvaluationContext.
EvaluationContextConfigurers - Class in pro.verron.officestamper.preset: Utility class for configuring the EvaluationContext used by officestamper.
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<T>) - 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
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.
ExperimentalStampers - Class in pro.verron.officestamper.preset: 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.
expression() - Method in interface pro.verron.officestamper.api.Placeholder: Retrieves the expression of the placeholder.
extractCommentElements(WordprocessingMLPackage) - Static method in class pro.verron.officestamper.utils.WmlUtils

F

fallback() - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that can act as a fallback resolver.
from(ContentAccessor) - Method in interface pro.verron.officestamper.api.DocxPart
from(ContentAccessor) - Method in class pro.verron.officestamper.experimental.PptxPart
function() - Method in record class pro.verron.officestamper.api.CustomFunction: Returns the value of the function record component.

G

getChildren() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the children of the comment.
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
getComment() - Method in class pro.verron.officestamper.experimental.PowerpointParagraph
getCommentProcessors() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Returns a map of comment processors associated with their respective classes.
getCommentRangeEnd() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the CommentRangeEnd object associated with this comment.
getCommentRangeStart() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the CommentRangeStart object associated with this comment.
getCommentReference() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the R.CommentReference object associated with this comment.
getCurrentCommentWrapper() - Method in class pro.verron.officestamper.api.AbstractCommentProcessor
getCurrentRun() - Method in class pro.verron.officestamper.api.AbstractCommentProcessor
getDocument() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the WordprocessingMLPackage document.
getElements() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the elements in the document that are between the comment range anchors.
getEvaluationContextConfigurer() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the EvaluationContextConfigurer for configuring the Spring Expression Language (SPEL) EvaluationContext used by the docxstamper.
getExceptionResolver() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration
getExpressionFunctions() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the map of expression functions associated with their corresponding classes.
getFirstParentWithClass(Child, Class<T>, int) - Static method in class pro.verron.officestamper.utils.WmlUtils
getImageBytes() - Method in class pro.verron.officestamper.preset.Image: Deprecated, for removal: This API element is subject to removal in a future version.
use the Image.newRun(DocxPart, String, String) method directly to generate a Run with Inline Drawing
getLineBreakPlaceholder() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the line break placeholder used in the OfficeStamper configuration.
getMaxWidth() - Method in class pro.verron.officestamper.preset.Image: Deprecated, for removal: This API element is subject to removal in a future version.
use the Image.newRun(DocxPart, String, String) method directly to generate a Run with Inline Drawing
getP() - Method in interface pro.verron.officestamper.api.Paragraph: Deprecated, for removal: This API element is subject to removal in a future version.
As of version 2.6, due to its direct exposure of the docx4j API. It is scheduled for removal in the future.
getP() - Method in class pro.verron.officestamper.experimental.PowerpointParagraph
getParagraph() - Method in class pro.verron.officestamper.api.AbstractCommentProcessor
getParagraph() - Method in interface pro.verron.officestamper.api.CommentProcessor
getParent() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the parent of the comment.
getPreprocessors() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the list of pre-processors.
getResolvers() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the list of ObjectResolvers.
getSpelParserConfiguration() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the SpelParserConfiguration used by the OfficeStamperConfiguration.
getUnresolvedExpressionsDefaultValue() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Deprecated, for removal: This API element is subject to removal in a future version.
This method is deprecated because it offers limited functionality by just checking a flag. It is replaced by OfficeStamperConfiguration.setExceptionResolver(ExceptionResolver) , which provides complete customization over the behavior during resolution failures. The new method allows you to define how unresolved expressions are handled in a more flexible and comprehensive manner.

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.ProcessorContext: 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.preset.Paragraphs: 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: headers.

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(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.
isFailOnUnresolvedExpression() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Deprecated, for removal: This API element is subject to removal in a future version.
This method is deprecated because it offers limited functionality by just checking a flag. It is replaced by OfficeStamperConfiguration.setExceptionResolver(ExceptionResolver) , which provides complete customization over the behavior during resolution failures. The new method allows you to define how unresolved expressions are handled in a more flexible and comprehensive manner.
isLeaveEmptyOnExpressionError() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Deprecated, for removal: This API element is subject to removal in a future version.
This method is deprecated because it offers limited functionality by just checking a flag. It is replaced by OfficeStamperConfiguration.setExceptionResolver(ExceptionResolver) , which provides complete customization over the behavior during resolution failures. The new method allows you to define how unresolved expressions are handled in a more flexible and comprehensive manner.
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.
isReplaceUnresolvedExpressions() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Deprecated, for removal: This API element is subject to removal in a future version.
This method is deprecated because it offers limited functionality by just checking a flag. It is replaced by OfficeStamperConfiguration.setExceptionResolver(ExceptionResolver) , which provides complete customization over the behavior during resolution failures. The new method allows you to define how unresolved expressions are handled in a more flexible and comprehensive manner.
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.

L

leaveEmptyOnExpressionError(boolean) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Deprecated, for removal: This API element is subject to removal in a future version.
This method is deprecated because it offers limited functionality by just checking a flag. It is replaced by OfficeStamperConfiguration.setExceptionResolver(ExceptionResolver) , which provides complete customization over the behavior during resolution failures. The new method allows you to define how unresolved expressions are handled in a more flexible and comprehensive manner.
legacyBehavior(boolean, boolean, boolean, String) - Static method in class pro.verron.officestamper.preset.ExceptionResolvers: Deprecated, for removal: This API element is subject to removal in a future version.
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.
listIterator(int) - Method in class pro.verron.officestamper.preset.StampTable
LOGGER - Static variable in interface pro.verron.officestamper.api.ObjectResolver

M

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.

N

name() - Method in record class pro.verron.officestamper.api.CustomFunction: Returns the value of the name record component.
newBody(List<Object>) - Static method in class pro.verron.officestamper.utils.WmlFactory: Creates a new Body object containing the provided elements.
newComment(BigInteger, String) - Static method in class pro.verron.officestamper.utils.WmlFactory: Creates a new comment with the provided value.
newCommentRangeEnd(BigInteger, P) - Static method in class pro.verron.officestamper.utils.WmlFactory
newCommentRangeStart(BigInteger, P) - Static method in class pro.verron.officestamper.utils.WmlFactory
newCommentReference(BigInteger, P) - Static method in class pro.verron.officestamper.utils.WmlFactory
newComments(List<Comments.Comment>) - Static method in class pro.verron.officestamper.utils.WmlFactory: Creates a new Comments object and populates it with a list of Comment objects.
newCommentsPart() - Static method in class pro.verron.officestamper.utils.WmlFactory: Creates a new CommentsPart object.
newDrawing(Inline) - Static method in class pro.verron.officestamper.utils.WmlFactory: Creates a new Drawing object containing the provided Inline object.
newInline(BinaryPartAbstractImage, String, String, Integer) - Static method in class pro.verron.officestamper.utils.WmlFactory: Creates a new Inline object for the given image part, filename hint, and alt text.
newParagraph(String) - Static method in class pro.verron.officestamper.utils.WmlFactory: Creates a new paragraph containing the provided string value.
newParagraph(String...) - Static method in class pro.verron.officestamper.utils.WmlFactory: Creates a new paragraph containing the provided text values.
newParagraph(List<?>) - Static method in class pro.verron.officestamper.utils.WmlFactory: Creates a new paragraph containing the provided values.
newParagraph(Drawing) - Static method in class pro.verron.officestamper.utils.WmlFactory: Creates a new paragraph containing a single drawing.
newParagraph(R) - Static method in class pro.verron.officestamper.utils.WmlFactory: Creates a new paragraph containing the provided run.
newPPr() - Static method in class pro.verron.officestamper.utils.WmlFactory: Creates a new PPr (paragraph properties) object.
newRun(Integer, BinaryPartAbstractImage, String, String) - Static method in class pro.verron.officestamper.utils.WmlFactory: Creates a new run containing an image with the specified attributes.
newRun(String) - Static method in class pro.verron.officestamper.utils.WmlFactory: Creates a new run containing the provided string value.
newRun(Drawing) - Static method in class pro.verron.officestamper.utils.WmlFactory: Creates a new run containing a single drawing.
newRun(Text) - Static method in class pro.verron.officestamper.utils.WmlFactory: Creates a new run containing a single text object.
newRun(DocxPart, String, String) - Method in class pro.verron.officestamper.preset.Image: Creates a new run with the provided image and associated metadata.
newText(String) - Static method in class pro.verron.officestamper.utils.WmlFactory: Creates a new Text object with the specified value, preserving spaces.
noopConfigurer() - Static method in class pro.verron.officestamper.preset.EvaluationContextConfigurers: Returns a EvaluationContextConfigurer instance that does no customization.
nullToDefault(String) - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves null objects 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 objects by not replacing their expression.

O

ObjectResolver - Interface in pro.verron.officestamper.api: The ObjectResolver interface provides a contract for resolving objects to create a run with the resolved content.
oddNumberOfBreaks() - Method in record class pro.verron.officestamper.preset.Paragraphs: Returns the value of the oddNumberOfBreaks record component.
OfficeStamper<T> - Interface in pro.verron.officestamper.api: This is an interface that defines the contract for stamping templates with context and writing the result to an OutputStream.
OfficeStamperConfiguration - Interface in pro.verron.officestamper.api: Interface representing the configuration for the Office Stamper functionality.
OfficeStamperConfigurations - Class in pro.verron.officestamper.preset: The OfficeStamperConfigurations class provides static methods to create different configurations for the 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: Main class of the docx-stamper library.

P

paragraph() - Method in record class pro.verron.officestamper.api.ProcessorContext: Returns the value of the paragraph record component.
Paragraph - Interface in pro.verron.officestamper.api: The Paragraph interface represents a paragraph in a text document.
ParagraphPlaceholderReplacer - Interface in pro.verron.officestamper.api: The ParagraphPlaceholderReplacer interface represents an object that can resolve expressions in a paragraph and replace them with values provided by an expression resolver.
Paragraphs - Record Class in pro.verron.officestamper.preset
Paragraphs(Comment, Iterator<Object>, List<Object>, Optional<SectPr>, boolean) - Constructor for record class pro.verron.officestamper.preset.Paragraphs: Creates an instance of a Paragraphs record class.
parameterTypes() - Method in record class pro.verron.officestamper.api.CustomFunction: Returns the value of the parameterTypes record component.
parent(Class<T>) - Method in interface pro.verron.officestamper.api.Paragraph: Retrieves the parent of the current paragraph that matches the specified class type.
parent(Class<T>) - Method in class pro.verron.officestamper.experimental.PowerpointParagraph
part() - Method in interface pro.verron.officestamper.api.DocxPart
part() - Method in class pro.verron.officestamper.experimental.PptxPart
passing() - Static method in class pro.verron.officestamper.preset.ExceptionResolvers: The passing resolver will handle exceptions by returning the placeholder expression.
placeholder() - Method in record class pro.verron.officestamper.api.ProcessorContext: Returns the value of the placeholder record component.
Placeholder - Interface in pro.verron.officestamper.api: The Placeholder interface represents a placeholder in a text document.
placeholderReplacer - Variable in class pro.verron.officestamper.api.AbstractCommentProcessor: PlaceholderReplacer used to replace expressions in the comment text.
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<T>) - 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: Represents a run within 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 functionality for stamping Powerpoint presentations with context and writing the result to an OutputStream.
PowerpointStamper() - Constructor for class pro.verron.officestamper.experimental.PowerpointStamper
PptxPart - Class in pro.verron.officestamper.experimental
PptxPart() - Constructor for class pro.verron.officestamper.experimental.PptxPart
pptxStamper() - Static method in class pro.verron.officestamper.preset.ExperimentalStampers: Returns a new instance of the OfficeStamper implementation for stamping PowerPoint presentations with context and writing the result to an OutputStream.
PreProcessor - Interface in pro.verron.officestamper.api: An interface for pre-processors that are called before the actual processing of a document takes place.
Preprocessors - Class in pro.verron.officestamper.preset: A helper class that provides pre-processing functionality for WordprocessingMLPackage documents.
previousSectionBreak() - Method in record class pro.verron.officestamper.preset.Paragraphs: Returns the value of the previousSectionBreak record component.
pro.verron.officestamper - module pro.verron.officestamper: This module serves as the main module for the "pro.verron.officestamper" application.
pro.verron.officestamper.api - package pro.verron.officestamper.api
pro.verron.officestamper.experimental - package pro.verron.officestamper.experimental
pro.verron.officestamper.preset - package pro.verron.officestamper.preset: This package provides presets and recommended configurations for docxstamper library users;
pro.verron.officestamper.utils - package pro.verron.officestamper.utils
process(WordprocessingMLPackage) - Method in interface pro.verron.officestamper.api.PreProcessor: Processes the given document before the actual processing takes place.
processorContext(Placeholder) - Method in interface pro.verron.officestamper.api.Paragraph: Creates a processor context for the given placeholder within this paragraph.
processorContext(Placeholder) - Method in class pro.verron.officestamper.experimental.PowerpointParagraph
ProcessorContext - Record Class in pro.verron.officestamper.api: Represents the context in which a processor operates in a text document.
ProcessorContext(Paragraph, R, Comment, Placeholder) - Constructor for record class pro.verron.officestamper.api.ProcessorContext: Creates an instance of a ProcessorContext record class.

R

raw() - Static method in class pro.verron.officestamper.preset.OfficeStamperConfigurations: Creates a new standard OfficeStamperConfiguration.
remove() - Method in interface pro.verron.officestamper.api.Paragraph: Removes the paragraph from the document.
remove() - Method in class pro.verron.officestamper.experimental.PowerpointParagraph
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
repeat(ParagraphPlaceholderReplacer) - Method in class pro.verron.officestamper.preset.CommentProcessorFactory
repeatDocPart(Iterable<Object>) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IRepeatDocPartProcessor
repeatDocPart(ParagraphPlaceholderReplacer) - Method in class pro.verron.officestamper.preset.CommentProcessorFactory
repeatParagraph(Iterable<Object>) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IParagraphRepeatProcessor
repeatParagraph(ParagraphPlaceholderReplacer) - Method in class pro.verron.officestamper.preset.CommentProcessorFactory
repeatTableRow(Iterable<Object>) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IRepeatProcessor
replace(int, int, String) - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Replaces a substring within the run's text.
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.experimental.PowerpointParagraph
replace(Placeholder, Object) - Method in interface pro.verron.officestamper.api.Paragraph: Replaces a placeholder in the given paragraph with the specified replacement.
replace(Placeholder, Object) - Method in class pro.verron.officestamper.experimental.PowerpointParagraph: Replaces the given expression with the replacement object within the paragraph.
replace(Placeholder, String) - Method in class pro.verron.officestamper.experimental.ExcelParagraph: Replaces the given expression with the replacement object within the paragraph.
replaceAll(Placeholder, R) - Method in interface pro.verron.officestamper.api.Paragraph: Deprecated, for removal: This API element is subject to removal in a future version.
was used by the core to deal with multiline paragraphs, users should fallback to Paragraph.replace(Placeholder, Object) only
replaceUnresolvedExpressions(boolean) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Deprecated, for removal: This API element is subject to removal in a future version.
This method is deprecated because it offers limited functionality by just checking a flag. It is replaced by OfficeStamperConfiguration.setExceptionResolver(ExceptionResolver) , which provides complete customization over the behavior during resolution failures. The new method allows you to define how unresolved expressions are handled in a more flexible and comprehensive manner.
replaceWith(ParagraphPlaceholderReplacer) - Method in class pro.verron.officestamper.preset.CommentProcessorFactory
replaceWordWith(String) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IReplaceWithProcessor
reset() - Method in interface pro.verron.officestamper.api.CommentProcessor: Resets all states in the comment processor so that it can be re-used in another stamping process.
resolve(WordprocessingMLPackage, String, Object) - Method in interface pro.verron.officestamper.api.ObjectResolver: Deprecated, for removal: This API element is subject to removal in a future version.
replaced by ObjectResolver.resolve(DocxPart, String, 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, Placeholder, Object) - Method in interface pro.verron.officestamper.api.ObjectResolver: Resolves the expression in the given document with the provided object.
resolve(Placeholder, String, Exception) - Method in interface pro.verron.officestamper.api.ExceptionResolver
resolve(T) - Method in class pro.verron.officestamper.api.StringResolver: Resolves an object to a string.
resolveExpressionsForParagraph(DocxPart, Paragraph, Object) - Method in interface pro.verron.officestamper.api.ParagraphPlaceholderReplacer: Finds expressions in the given paragraph and replaces them with the values provided by the expression resolver.
resolveExpressionsForParagraph(Paragraph, Object, WordprocessingMLPackage) - Method in interface pro.verron.officestamper.api.ParagraphPlaceholderReplacer: Deprecated, for removal: This API element is subject to removal in a future version.
replaced by ParagraphPlaceholderReplacer.resolveExpressionsForParagraph(DocxPart, Paragraph, Object)
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
run() - Method in record class pro.verron.officestamper.api.ProcessorContext: Returns the value of the run record component.
run() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Returns the value of the run record component.

S

setChildren(Set<Comment>) - Method in interface pro.verron.officestamper.api.Comment: Sets the children of the comment.
setComment(Comments.Comment) - Method in interface pro.verron.officestamper.api.Comment: Sets the comment for this object.
setCommentRangeEnd(CommentRangeEnd) - Method in interface pro.verron.officestamper.api.Comment: Sets the CommentRangeEnd object associated with this comment.
setCommentRangeStart(CommentRangeStart) - Method in interface pro.verron.officestamper.api.Comment: Sets the CommentRangeStart object associated with this comment.
setCommentReference(R.CommentReference) - Method in interface pro.verron.officestamper.api.Comment: Sets the comment reference for this comment.
setCurrentCommentWrapper(Comment) - Method in class pro.verron.officestamper.api.AbstractCommentProcessor
setCurrentCommentWrapper(Comment) - Method in interface pro.verron.officestamper.api.CommentProcessor: Passes the comment range wrapper that is currently being processed (i.e., the start and end of comment that in the .docx template).
setCurrentRun(R) - Method in class pro.verron.officestamper.api.AbstractCommentProcessor
setCurrentRun(R) - Method in interface pro.verron.officestamper.api.CommentProcessor: Passes the run that is currently being processed (i.e., the run that is commented in the .docx template).
setEvaluationContextConfigurer(EvaluationContextConfigurer) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Sets the EvaluationContextConfigurer for configuring the Spring Expression Language (SPEL) EvaluationContext.
setExceptionResolver(ExceptionResolver) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration
setFailOnUnresolvedExpression(boolean) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Deprecated, for removal: This API element is subject to removal in a future version.
This method is deprecated because it offers limited functionality by just checking a flag. It is replaced by OfficeStamperConfiguration.setExceptionResolver(ExceptionResolver) , which provides complete customization over the behavior during resolution failures. The new method allows you to define how unresolved expressions are handled in a more flexible and comprehensive manner.
setLineBreakPlaceholder(String) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Sets the line break placeholder used in the OfficeStamper configuration.
setParagraph(P) - Method in class pro.verron.officestamper.api.AbstractCommentProcessor: Deprecated, for removal: This API element is subject to removal in a future version.
use AbstractCommentProcessor.setParagraph(Paragraph) instead
setParagraph(P) - Method in interface pro.verron.officestamper.api.CommentProcessor: Deprecated, for removal: This API element is subject to removal in a future version.
use CommentProcessor.setProcessorContext(ProcessorContext) instead
setParagraph(Paragraph) - Method in class pro.verron.officestamper.api.AbstractCommentProcessor
setProcessorContext(ProcessorContext) - Method in class pro.verron.officestamper.api.AbstractCommentProcessor
setProcessorContext(ProcessorContext) - Method in interface pro.verron.officestamper.api.CommentProcessor
setResolvers(List<ObjectResolver>) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Sets the list of object resolvers for the OfficeStamper configuration.
setSpelParserConfiguration(SpelParserConfiguration) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Sets the SpelParserConfiguration used by the OfficeStamperConfiguration.
size() - Method in class pro.verron.officestamper.preset.StampTable
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, OutputStream) - Method in class pro.verron.officestamper.experimental.PowerpointStamper
stamp(SpreadsheetMLPackage, Object, OutputStream) - Method in class pro.verron.officestamper.experimental.ExcelStamper
stamp(T, Object, OutputStream) - Method in interface pro.verron.officestamper.api.OfficeStamper: Stamps the template with the context and writes the result to the outputStream.
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<String>, List<List<String>>) - 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 new standard OfficeStamperConfiguration.
standardWithPreprocessing() - Static method in class pro.verron.officestamper.preset.OfficeStamperConfigurations: Creates a new OfficeStamperConfiguration with the standard configuration and additional preprocessors.
startIndex() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Returns the value of the startIndex record component.
streamParagraphs() - Method in interface pro.verron.officestamper.api.DocxPart
streamParagraphs() - Method in class pro.verron.officestamper.experimental.PptxPart
streamParts(String) - Method in interface pro.verron.officestamper.api.DocxDocument
streamParts(String) - Method in class pro.verron.officestamper.experimental.PptxPart
streamRun() - Method in interface pro.verron.officestamper.api.DocxPart
streamRun() - Method in class pro.verron.officestamper.experimental.PptxPart
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<InputStream, T>, OfficeStamper<T>) - Constructor for class pro.verron.officestamper.api.StreamStamper: Constructs a new StreamStamper with the provided loader and stamper.
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<T>) - Constructor for class pro.verron.officestamper.api.StringResolver: Creates a new StringResolver with the given type.

T

tableResolver(ParagraphPlaceholderReplacer) - Method in class pro.verron.officestamper.preset.CommentProcessorFactory
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
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.ProcessorContext: Returns a string representation of this record class.
toString() - Method in class pro.verron.officestamper.experimental.ExcelParagraph
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.preset.Paragraphs: Returns a string representation of this record class.
TriFunction<T,U,V,W> - Interface in pro.verron.officestamper.utils

U

unresolvedExpressionsDefaultValue(String) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Deprecated, for removal: This API element is subject to removal in a future version.
This method is deprecated because it offers limited functionality by just checking a flag. It is replaced by OfficeStamperConfiguration.setExceptionResolver(ExceptionResolver) , which provides complete customization over the behavior during resolution failures. The new method allows you to define how unresolved expressions are handled in a more flexible and comprehensive manner.

V

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<T, U, ?>) - Method in interface pro.verron.officestamper.api.CustomFunction.NeedsBiFunctionImpl
withImplementation(Function<T, ?>) - Method in interface pro.verron.officestamper.api.CustomFunction.NeedsFunctionImpl
withImplementation(TriFunction<T, U, V, ?>) - Method in interface pro.verron.officestamper.api.CustomFunction.NeedsTriFunctionImpl
WmlFactory - Class in pro.verron.officestamper.utils: WmlFactory is a utility class providing methods to create and manipulate WordML objects.
WmlUtils - Class in pro.verron.officestamper.utils

X

xlsxStamper() - Static method in class pro.verron.officestamper.preset.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