Class SnippetMacro

  • All Implemented Interfaces:
    LogEnabled, Macro

    @Component(role=Macro.class,
               hint="snippet")
    public class SnippetMacro
    extends AbstractMacro
    A macro that prints out the content of a file or a URL.
    • Constructor Detail

      • SnippetMacro

        public SnippetMacro()
    • Method Detail

      • execute

        public void execute​(Sink sink,
                            MacroRequest request)
                     throws MacroExecutionException
        Execute the current macro using the given MacroRequest, and emit events into the given sink.
        Parameters:
        sink - The sink to receive the events.
        request - The corresponding MacroRequest.
        Throws:
        MacroExecutionException - if an error occurred during execution.
      • cacheSnippet

        public void cacheSnippet​(URL url,
                                 String id,
                                 String content)
        Puts the given snippet into the cache.
        Parameters:
        url - The URL to parse.
        id - The id of the snippet.
        content - The content of the snippet.
      • setCacheTimeout

        public void setCacheTimeout​(int time)
        Set the cache timeout.
        Parameters:
        time - The timeout to set.