Interface Hook

All Known Subinterfaces:
DocxHook
All Known Implementing Classes:
CommentHook, TagHook
public interface Hook
Represents a hook that can be used to extend or customize the behavior of an OfficeStamper document processing flow. Implementations of this interface provide a mechanism to execute specific logic within the context of a document. A Hook can be used, for example, to process specific elements within a document structure (like smart tags or comments), attach custom logic, or handle context-specific processing during document rendering.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    setContextKey(String contextKey)
    Sets the context key associated with this hook.

  • Method Details

    • setContextKey

      void setContextKey(String contextKey)
      Sets the context key associated with this hook. The context key is a unique identifier that can be used to match or scope the hook's execution within a specific ContextTree branch during document processing.
      Parameters:
      contextKey - the unique key representing the context in which this hook should operate