Interface ICommentProcessor

All Superinterfaces:
IProcessor
All Known Implementing Classes:
AbstractCommentProcessor, StandardConditionalCommentProcessor, StandardInliningCommentProcessor

public interface ICommentProcessor extends IProcessor

Base interface for all processors that execute on Comment events (IComment).

Since:
3.0.0
Author:
Daniel Fernández
See Also:
  • Method Details

    • process

      void process(ITemplateContext context, IComment comment, ICommentStructureHandler structureHandler)

      Execute the processor.

      The IComment object argument is immutable, so all modifications to this object or any instructions to be given to the engine should be done through the specified ICommentStructureHandler handler.

      Parameters:
      context - the execution context.
      comment - the event this processor is executing on.
      structureHandler - the handler that will centralise modifications and commands to the engine.