Package org.opencms.loader

Class CmsTransformerTemplateProvider.Configuration

java.lang.Object

org.opencms.loader.CmsTransformerTemplateProvider.Configuration

Enclosing class:

CmsTransformerTemplateProvider

public class CmsTransformerTemplateProvider.Configuration
extends Object

Contains the configuration data for the provider, usually read from a configuration file.

Constructor Summary

Constructors

Constructor	Description
Configuration()	Creates a new instance.
Configuration(JSONObject configJson)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
Map<String,CmsTemplateContext>	getContextMap()	Gets the map of template contexts, with their internal names as keys.
Pattern	getFunctionFilter(String key)	Gets the function filter pattern used to filter dynamic function paths.
CmsJsonMessageContainer	getMenuLabel()	Gets the label for the context menu
String	getTemplateCompatibility(String currentContext)	Gets the template compatibility for the given template context.

Methods inherited from class java.lang.Object

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

Constructor Details

Configuration

public Configuration()

Creates a new instance.

Configuration

public Configuration(JSONObject configJson)
              throws JSONException

Creates a new instance.

Parameters:

configJson - the configuration JSON object

Throws:

JSONException - if something goes wrong with the JSON

Method Details

getContextMap

public Map<String,CmsTemplateContext> getContextMap()

Gets the map of template contexts, with their internal names as keys.

Returns:

the map of template contexts

getFunctionFilter

public Pattern getFunctionFilter(String key)

Gets the function filter pattern used to filter dynamic function paths.

If this returns null, dynamic functions shouldn't be filtered.

Parameters:

key - the template context key

Returns:

the dynamic function filter

getMenuLabel

public CmsJsonMessageContainer getMenuLabel()

Gets the label for the context menu

Returns:

the label for the context menu

getTemplateCompatibility

public String getTemplateCompatibility(String currentContext)

Gets the template compatibility for the given template context.

Parameters:

currentContext - the current template context

Returns:

the template compatibility for the template context