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
public class SnippetMacro
- extends AbstractMacro
A macro that prints out the content of a file or a URL.
Fields inherited from interface org.apache.maven.doxia.macro.Macro |
ROLE |
Method Summary |
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 |
SnippetMacro
public SnippetMacro()
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.
Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.