java.lang.Object
- io.quarkus.qute.EngineBuilder

public final class EngineBuilder
extends Object

Builder for Engine.

If using Qute "standalone" you'll need to create an instance of the Engine first:

 Engine engine = Engine.builder()
         // add the default set of value resolvers and section helpers
         .addDefaults()
         .build();

This construct is not thread-safe and should not be reused.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`EngineBuilder`	`addDefaults()`	Add the default set of value resolvers and section helpers.
`EngineBuilder`	`addDefaultSectionHelpers()`
`EngineBuilder`	`addDefaultValueResolvers()`	Add the default set of value resolvers.
`EngineBuilder`	`addLocator(TemplateLocator locator)`	A `Reader` instance produced by a locator is immediately closed right after the template content is parsed.
`EngineBuilder`	`addNamespaceResolver(NamespaceResolver resolver)`
`EngineBuilder`	`addParserHook(ParserHook parserHook)`
`EngineBuilder`	`addResultMapper(ResultMapper mapper)`
`EngineBuilder`	`addSectionHelper(SectionHelperFactory<?> factory)`	Register the factory for all default aliases.
`EngineBuilder`	`addSectionHelper(String name, SectionHelperFactory<?> factory)`	Register the factory for all default aliases and the specified name.
`EngineBuilder`	`addSectionHelpers(SectionHelperFactory<?>... factories)`	Register the factories for all default aliases.
`EngineBuilder`	`addTemplateInstanceInitializer(TemplateInstance.Initializer initializer)`
`EngineBuilder`	`addValueResolver(ValueResolver resolver)`
`EngineBuilder`	`addValueResolver(Supplier<ValueResolver> resolverSupplier)`
`EngineBuilder`	`addValueResolvers(ValueResolver... resolvers)`
`Engine`	`build()`
`EngineBuilder`	`computeSectionHelper(Function<String,SectionHelperFactory<?>> func)`	The function is used if no section helper registered via `addSectionHelper(SectionHelperFactory)` matches a section name.
`EngineBuilder`	`iterationMetadataPrefix(String prefix)`	This prefix is used to access the iteration metadata inside a loop section.
`EngineBuilder`	`removeStandaloneLines(boolean value)`	Specify whether the parser should remove standalone lines from the output.
`EngineBuilder`	`strictRendering(boolean value)`	If set to `true` then any expression that is evaluated to a `Results.NotFound` will always result in a `TemplateException` and the rendering is aborted.
`EngineBuilder`	`timeout(long value)`	The global rendering timeout.
`EngineBuilder`	`useAsyncTimeout(boolean value)`	If set to `true` the timeout (either global or set via the `timeout` instance attribute) is also used for asynchronous rendering methods, such as `TemplateInstance.createUni()` and `TemplateInstance.renderAsync()`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - addSectionHelper
```
public EngineBuilder addSectionHelper(SectionHelperFactory<?> factory)
```
    Register the factory for all default aliases.
    
    Parameters:
    
    factory -
    
    Returns:
    
    self
    
    See Also:
    
    SectionHelperFactory.getDefaultAliases()
  - addSectionHelpers
```
public EngineBuilder addSectionHelpers(SectionHelperFactory<?>... factories)
```
    Register the factories for all default aliases.
    
    Parameters:
    
    factory -
    
    Returns:
    
    self
    
    See Also:
    
    SectionHelperFactory.getDefaultAliases()
  - addSectionHelper
```
public EngineBuilder addSectionHelper(String name,
                                      SectionHelperFactory<?> factory)
```
    Register the factory for all default aliases and the specified name.
    
    Parameters:
    
    factory -
    
    Returns:
    
    self
    
    See Also:
    
    SectionHelperFactory.getDefaultAliases()
  - addDefaultSectionHelpers
```
public EngineBuilder addDefaultSectionHelpers()
```
  - addValueResolver
```
public EngineBuilder addValueResolver(Supplier<ValueResolver> resolverSupplier)
```
  - addValueResolvers
```
public EngineBuilder addValueResolvers(ValueResolver... resolvers)
```
  - addValueResolver
```
public EngineBuilder addValueResolver(ValueResolver resolver)
```
  - addDefaultValueResolvers
```
public EngineBuilder addDefaultValueResolvers()
```
    Add the default set of value resolvers.
    
    Returns:
    
    self
    
    See Also:
    
    addValueResolver(ValueResolver)
  - addDefaults
```
public EngineBuilder addDefaults()
```
    Add the default set of value resolvers and section helpers.
    
    Returns:
    
    self
    
    See Also:
    
    addValueResolver(ValueResolver), addSectionHelper(SectionHelperFactory)
  - addNamespaceResolver
```
public EngineBuilder addNamespaceResolver(NamespaceResolver resolver)
```
    Parameters:
    
    resolver -
    
    Returns:
    
    self
    
    Throws:
    
    IllegalArgumentException - if there is a resolver of the same priority for the given namespace
  - addLocator
```
public EngineBuilder addLocator(TemplateLocator locator)
```
    A Reader instance produced by a locator is immediately closed right after the template content is parsed.
    
    Parameters:
    
    locator -
    
    Returns:
    
    self
    
    See Also:
    
    Engine.getTemplate(String)
  - addParserHook
```
public EngineBuilder addParserHook(ParserHook parserHook)
```
    Parameters:
    
    parserHook -
    
    Returns:
    
    self
    
    See Also:
    
    ParserHelper
  - addResultMapper
```
public EngineBuilder addResultMapper(ResultMapper mapper)
```
    Parameters:
    
    resultMapper -
    
    Returns:
    
    self
  - addTemplateInstanceInitializer
```
public EngineBuilder addTemplateInstanceInitializer(TemplateInstance.Initializer initializer)
```
    Parameters:
    
    initializer -
    
    Returns:
    
    self
  - computeSectionHelper
```
public EngineBuilder computeSectionHelper(Function<String,SectionHelperFactory<?>> func)
```
    The function is used if no section helper registered via addSectionHelper(SectionHelperFactory) matches a section name.
    
    Parameters:
    
    func -
    
    Returns:
    
    self
  - removeStandaloneLines
```
public EngineBuilder removeStandaloneLines(boolean value)
```
    Specify whether the parser should remove standalone lines from the output.
    A standalone line is a line that contains at least one section tag, parameter declaration, or comment but no expression and no non-whitespace character.
    
    Parameters:
    
    value -
    
    Returns:
    
    self
  - strictRendering
```
public EngineBuilder strictRendering(boolean value)
```
    If set to true then any expression that is evaluated to a Results.NotFound will always result in a TemplateException and the rendering is aborted.
    Strict rendering is enabled by default.
    
    Parameters:
    
    value -
    
    Returns:
    
    self
  - iterationMetadataPrefix
```
public EngineBuilder iterationMetadataPrefix(String prefix)
```
    This prefix is used to access the iteration metadata inside a loop section. This method must be called before a LoopSectionHelper.Factory is registered, i.e. before addDefaultSectionHelpers() or before addSectionHelper(SectionHelperFactory).
    A valid prefix consists of alphanumeric characters and underscores.
    Keep in mind that the prefix must be set before the LoopSectionHelper.Factory is registered, for example before the addDefaultSectionHelpers() method is called. In other words, the LoopSectionHelper.Factory must be re-registered after the prefix is set.
    
    Parameters:
    
    prefix -
    
    Returns:
    
    self
    
    See Also:
    
    LoopSectionHelper.Factory
  - timeout
```
public EngineBuilder timeout(long value)
```
    The global rendering timeout.
    
    Parameters:
    
    value - Timeout in milliseconds
    
    Returns:
    
    self
  - useAsyncTimeout
```
public EngineBuilder useAsyncTimeout(boolean value)
```
    If set to true the timeout (either global or set via the timeout instance attribute) is also used for asynchronous rendering methods, such as TemplateInstance.createUni() and TemplateInstance.renderAsync().
    
    Parameters:
    
    value -
    
    Returns:
    
    self
  - build
```
public Engine build()
```
    Returns:
    
    a new engine instance

Class EngineBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addSectionHelper

addSectionHelpers

addSectionHelper

addDefaultSectionHelpers

addValueResolver

addValueResolvers

addValueResolver

addDefaultValueResolvers

addDefaults

addNamespaceResolver

addLocator

addParserHook

addResultMapper

addTemplateInstanceInitializer

computeSectionHelper

removeStandaloneLines

strictRendering

iterationMetadataPrefix

timeout

useAsyncTimeout

build