org.xwiki.rendering.internal.macro.cache
Class CacheMacro

java.lang.Object
  org.xwiki.rendering.macro.AbstractMacro<CacheMacroParameters>
      org.xwiki.rendering.internal.macro.cache.CacheMacro

All Implemented Interfaces:

java.lang.Comparable<org.xwiki.rendering.macro.Macro<?>>, org.xwiki.component.phase.Initializable, org.xwiki.rendering.macro.Macro<CacheMacroParameters>

@Component
@Named(value="cache")
@Singleton
public class CacheMacro
extends org.xwiki.rendering.macro.AbstractMacro<CacheMacroParameters>
implements org.xwiki.component.phase.Initializable

Provides Caching for the content of the macro.

Since:

3.0M1

Version:

$Id$

Field Summary

Fields inherited from class org.xwiki.rendering.macro.AbstractMacro

beanManager, DEFAULT_CATEGORY_CONTENT, DEFAULT_CATEGORY_DEVELOPMENT, DEFAULT_CATEGORY_FORMATTING, DEFAULT_CATEGORY_NAVIGATION

Constructor Summary

CacheMacro()
Create and initialize the descriptor of the macro.

Method Summary

java.util.List<Block>	execute(CacheMacroParameters parameters, java.lang.String content, org.xwiki.rendering.transformation.MacroTransformationContext context)
void	initialize()
boolean	supportsInlineMode()

Methods inherited from class org.xwiki.rendering.macro.AbstractMacro

compareTo, getDescriptor, getPriority, setDefaultCategory, setDescriptor, setPriority

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CacheMacro

public CacheMacro()

Create and initialize the descriptor of the macro.

Method Detail

initialize

public void initialize()
                throws org.xwiki.component.phase.InitializationException

Specified by:

initialize in interface org.xwiki.component.phase.Initializable

Overrides:

initialize in class org.xwiki.rendering.macro.AbstractMacro<CacheMacroParameters>

Throws:

org.xwiki.component.phase.InitializationException

See Also:

Initializable.initialize()

supportsInlineMode

public boolean supportsInlineMode()

Specified by:

supportsInlineMode in interface org.xwiki.rendering.macro.Macro<CacheMacroParameters>

See Also:

Macro.supportsInlineMode()

execute

public java.util.List<Block> execute(CacheMacroParameters parameters,
                                     java.lang.String content,
                                     org.xwiki.rendering.transformation.MacroTransformationContext context)
                              throws org.xwiki.rendering.macro.MacroExecutionException

Specified by:

execute in interface org.xwiki.rendering.macro.Macro<CacheMacroParameters>

Throws:

org.xwiki.rendering.macro.MacroExecutionException

See Also:

Macro.execute(Object, String, MacroTransformationContext)