Package org.opencms.loader
Class CmsTransformerTemplateProvider.Configuration
- java.lang.Object
-
- org.opencms.loader.CmsTransformerTemplateProvider.Configuration
-
- Enclosing class:
- CmsTransformerTemplateProvider
public class CmsTransformerTemplateProvider.Configuration extends java.lang.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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Map<java.lang.String,CmsTemplateContext>
getContextMap()
Gets the map of template contexts, with their internal names as keys.java.util.regex.Pattern
getFunctionFilter(java.lang.String key)
Gets the function filter pattern used to filter dynamic function paths.CmsJsonMessageContainer
getMenuLabel()
Gets the label for the context menujava.lang.String
getTemplateCompatibility(java.lang.String currentContext)
Gets the template compatibility for the given template context.
-
-
-
Constructor Detail
-
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 Detail
-
getContextMap
public java.util.Map<java.lang.String,CmsTemplateContext> getContextMap()
Gets the map of template contexts, with their internal names as keys.- Returns:
- the map of template contexts
-
getFunctionFilter
public java.util.regex.Pattern getFunctionFilter(java.lang.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 java.lang.String getTemplateCompatibility(java.lang.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
-
-