Class PebbleEngine


  • public class PebbleEngine
    extends java.lang.Object
    The main class used for compiling templates. The PebbleEngine is responsible for delegating responsibility to the lexer, parser, compiler, and template cache.
    • Field Detail

      • logger

        private final org.slf4j.Logger logger
      • loader

        private final Loader<?> loader
      • syntax

        private final Syntax syntax
      • strictVariables

        private final boolean strictVariables
      • defaultLocale

        private final java.util.Locale defaultLocale
      • maxRenderedSize

        private final int maxRenderedSize
      • executorService

        private final java.util.concurrent.ExecutorService executorService
    • Constructor Detail

      • PebbleEngine

        private PebbleEngine​(Loader<?> loader,
                             Syntax syntax,
                             boolean strictVariables,
                             java.util.Locale defaultLocale,
                             int maxRenderedSize,
                             PebbleCache<CacheKey,​java.lang.Object> tagCache,
                             PebbleCache<java.lang.Object,​PebbleTemplate> templateCache,
                             java.util.concurrent.ExecutorService executorService,
                             ExtensionRegistry extensionRegistry,
                             ParserOptions parserOptions,
                             EvaluationOptions evaluationOptions)
        Constructor for the Pebble Engine given an instantiated Loader. This method does only load those userProvidedExtensions listed here.
        Parameters:
        loader - The template loader for this engine
        syntax - the syntax to use for parsing the templates.
    • Method Detail

      • getTemplate

        public PebbleTemplate getTemplate​(java.lang.String templateName)
        Loads, parses, and compiles a template into an instance of PebbleTemplate and returns this instance.
        Parameters:
        templateName - The name of the template
        Returns:
        PebbleTemplate The compiled version of the template
      • getLiteralTemplate

        public PebbleTemplate getLiteralTemplate​(java.lang.String templateName)
        Loads, parses, and compiles a template using a StringLoader into an instance of PebbleTemplate and returns this instance.
        Parameters:
        templateName - The name of the template
        Returns:
        PebbleTemplate The compiled version of the template
      • getTemplate

        private PebbleTemplate getTemplate​(java.lang.String templateName,
                                           Loader loader)
      • getPebbleTemplate

        private PebbleTemplate getPebbleTemplate​(java.lang.String templateName,
                                                 Loader loader,
                                                 java.lang.Object cacheKey)
      • getLoader

        public Loader<?> getLoader()
        Returns the loader
        Returns:
        The loader
      • getTemplateCache

        public PebbleCache<java.lang.Object,​PebbleTemplate> getTemplateCache()
        Returns the template cache
        Returns:
        The template cache
      • isStrictVariables

        public boolean isStrictVariables()
        Returns the strict variables setting
        Returns:
        The strict variables setting
      • getDefaultLocale

        public java.util.Locale getDefaultLocale()
        Returns the default locale
        Returns:
        The default locale
      • getMaxRenderedSize

        public int getMaxRenderedSize()
        Returns the max rendered size.
        Returns:
        The max rendered size.
      • getExecutorService

        public java.util.concurrent.ExecutorService getExecutorService()
        Returns the executor service
        Returns:
        The executor service
      • getSyntax

        public Syntax getSyntax()
        Returns the syntax which is used by this PebbleEngine.
        Returns:
        the syntax used by the PebbleEngine.
      • getExtensionRegistry

        public ExtensionRegistry getExtensionRegistry()
        Returns the extension registry.
        Returns:
        The extension registry
      • getTagCache

        public PebbleCache<CacheKey,​java.lang.Object> getTagCache()
        Returns the tag cache
        Returns:
        The tag cache