org.xwiki.rendering.macro.cache
Class CacheMacroParameters

java.lang.Object
  org.xwiki.rendering.macro.cache.CacheMacroParameters

public class CacheMacroParameters
extends java.lang.Object

Parameters for the Cache macro.

Since:

3.0M1

Version:

$Id$

Constructor Summary

CacheMacroParameters()

Method Summary

java.lang.String	getId()
void	setId(java.lang.String id)

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheMacroParameters

public CacheMacroParameters()

Method Detail

getId

public java.lang.String getId()

Returns:

the optional unique id to use to cache the content. If not defined then use the content itself as the id but this doesn't guarantee unicity since the same content could be located on several pages with different results. Also note that the id is considered containing wiki syntax; this is done so that the user can use script macros to generate the id

setId

public void setId(java.lang.String id)

Parameters:

id - refer to getId()