org.apache.maven.doxia.macro.snippet

Class SnippetMacro

public class SnippetMacro extends AbstractMacro

A macro that prints out the content of a file or a URL.

UNKNOWN: role-hint="snippet"

Method Summary
voidcacheSnippet(URL url, String id, String content)
Puts the given snippet into the cache.
voidexecute(Sink sink, MacroRequest request)
voidsetCacheTimeout(int time)
Set the cache timeout.

Method Detail

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.

execute

public void execute(Sink sink, MacroRequest request)
{@inheritDoc }

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.