Class SnippetMacro

  • All Implemented Interfaces:
    org.apache.maven.doxia.logging.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.
    • Field Summary

      • Fields inherited from interface org.apache.maven.doxia.macro.Macro

        EOL, ROLE
    • Constructor Summary

      Constructors 
      Constructor Description
      SnippetMacro()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void cacheSnippet​(java.net.URL url, java.lang.String id, java.lang.String content)
      Puts the given snippet into the cache.
      void execute​(org.apache.maven.doxia.sink.Sink sink, MacroRequest request)
      Execute the current macro using the given MacroRequest, and emit events into the given sink.
      void setCacheTimeout​(int time)
      Set the cache timeout.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • SnippetMacro

        public SnippetMacro()
    • Method Detail

      • execute

        public void execute​(org.apache.maven.doxia.sink.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​(java.net.URL url,
                                 java.lang.String id,
                                 java.lang.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.