org.xwiki.rendering.async

Class AsyncMacroParameters

java.lang.Object

org.xwiki.rendering.async.AsyncMacroParameters

public class AsyncMacroParameters
extends Object

Parameters for the AsyncMacro Macro.

Since:

11.6RC1

Version:

$Id: 874c18d15f2b8a41f30594ed9143f37d6f591c24 $

Constructor Summary

Constructors

Constructor and Description
AsyncMacroParameters()

Method Summary

Modifier and Type	Method and Description
Set<String>	getContext()
List<String>	getId()
boolean	isAsync()
boolean	isCached()
void	setAsync(boolean async)
void	setCached(boolean cached)
void	setContext(Set<String> contextEntries)
void	setId(List<String> id)

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncMacroParameters

public AsyncMacroParameters()

Method Detail

isAsync

public boolean isAsync()

Returns:

true if the content should be executed asynchronously

setAsync

public void setAsync(boolean async)

Parameters:

async - true if the content should be executed asynchronously

isCached

public boolean isCached()

Returns:

true if the result of the execution should be cached

setCached

public void setCached(boolean cached)

Parameters:

cached - true if the result of the execution should be cached

getContext

public Set<String> getContext()

Returns:

the context entries needed to execute the content

setContext

public void setContext(Set<String> contextEntries)

Parameters:

contextEntries - the context entries needed to execute the content

getId

public List<String> getId()

Returns:

the id to use instead of the generated one

setId

public void setId(List<String> id)

Parameters:

id - the id to use instead of the generated one