org.apache.maven.doxia.macro.snippet

Class SnippetMacro

java.lang.Object

org.apache.maven.doxia.macro.AbstractMacro

org.apache.maven.doxia.macro.snippet.SnippetMacro

All Implemented Interfaces:

Macro

@Singleton
 @Named(value="snippet")
public class SnippetMacro
extends AbstractMacro

A macro that prints out the (source code) content of a file or a URL.

Field Summary

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

EOL

Constructor Summary

Constructors

Constructor and Description
SnippetMacro()

Method Summary

Modifier and Type	Method and Description
void	cacheSnippet(URL url, String id, String content) Puts the given snippet into the cache.
void	execute(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 org.apache.maven.doxia.macro.AbstractMacro

getAttributesFromMap

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(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.