com.jivesoftware.base.plugin
Interface Macro

public interface Macro

Provides the ability to make simple custom macros to be used inside content such as blog posts, threads, documents, and comments. For more flexibility and control consider instead extending RenderMacro instead

Method Summary

String

render(String body, Map<String,String> parameters, MacroContext macroContext) Render the macro.

Method Detail

render

String render(String body,
              Map<String,String> parameters,
              MacroContext macroContext)

Render the macro.

Parameters:

body - The body content of the macro, if the macro has a body. This will be null otherwise.

parameters - The parameters passed into the macro.

macroContext - Provides extra information such as the JiveContext and PluginMetaDataImpl objects.

Returns:

The string rendered by the macro.