Package org.thymeleaf.processor.comment

Interface ICommentStructureHandler

All Known Implementing Classes:
CommentStructureHandler
public interface ICommentStructureHandler

Structure handler class meant to be used by ICommentProcessor implementations.

Structure handlers allow processors to instruct the engine to perform a series of actions that cannot be done directly from the processors themselves, usually because these actions are applied or have effects on scopes broader than the processed events themselves.

Since:
3.0.0
Author:
Daniel Fernández
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    removeComment()
    Instructs the engine to remove the entire event that is being processed.
    void
    replaceWith(IModel model, boolean processable)
    Instructs the engine to replace the current event with the specified model (a IModel).
    void
    reset()
    Resets all actions specified so far for the current processor execution.
    void
    setContent(CharSequence content)
    Instructs the engine to set a new content for this Comment.

  • Method Details

    • reset

      void reset()

      Resets all actions specified so far for the current processor execution.

    • setContent

      void setContent(CharSequence content)

      Instructs the engine to set a new content for this Comment.

      Parameters:
      content - the new content

    • replaceWith

      void replaceWith(IModel model, boolean processable)

      Instructs the engine to replace the current event with the specified model (a IModel).

      Parameters:
      model - the model to be used as a replacement.
      processable - whether the model should be considered processable or not.

    • removeComment

      void removeComment()

      Instructs the engine to remove the entire event that is being processed.