Package io.wcm.devops.conga.generator.spi.context

Class ValueProviderContext

java.lang.Object

io.wcm.devops.conga.generator.spi.context.AbstractPluginContext<ValueProviderContext>

io.wcm.devops.conga.generator.spi.context.ValueProviderContext

public final class ValueProviderContext
extends AbstractPluginContext<ValueProviderContext>

Context for a single ValueProviderPlugin instance.

Constructor Summary

Constructors

Constructor	Description
ValueProviderContext()

Method Summary

Modifier and Type	Method	Description
Object	getValueProviderCache()	Get cache object for the current value provider.
Object	getValueProviderConfig(String key)	Gets value provider config.
String	getValueProviderName()	Gets value provider name.
void	setValueProviderCache(Object object)	Set cache object for the current value provider.
ValueProviderContext	valueProviderGlobalContext(ValueProviderGlobalContext context)	Sets value provider global context.
ValueProviderContext	valueProviderName(String value)	Sets value provider name.

Methods inherited from class io.wcm.devops.conga.generator.spi.context.AbstractPluginContext

getContainerContext, getGenericPluginConfig, getLogger, getPluginContextOptions, getPluginManager, getUrlFileManager, pluginContextOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ValueProviderContext

public ValueProviderContext()

Method Details

valueProviderGlobalContext

public ValueProviderContext valueProviderGlobalContext(ValueProviderGlobalContext context)

Sets value provider global context.

Parameters:

context - Global value provider context

Returns:

this

valueProviderName

public ValueProviderContext valueProviderName(String value)

Sets value provider name.

Parameters:

value - Value provider name

Returns:

this

getValueProviderName

public String getValueProviderName()

Gets value provider name.

Returns:

Value provider name

getValueProviderConfig

public Object getValueProviderConfig(String key)

Gets value provider config.

Parameters:

key - Configuration parameter name

Returns:

Configuration for the current value provider. Never null.

getValueProviderCache

public Object getValueProviderCache()

Get cache object for the current value provider.

Returns:

Cache object or null if none was set yet

setValueProviderCache

public void setValueProviderCache(Object object)

Set cache object for the current value provider.

Parameters:

object - Cache object